Struct openssl::ssl::SslMode

pub struct SslMode { /* fields omitted */ }

Options controlling the behavior of an SslContext.

Methods

impl SslMode

pub const ENABLE_PARTIAL_WRITE: SslMode

Enables "short writes".

Normally, a write in OpenSSL will always write out all of the requested data, even if it requires more than one TLS record or write to the underlying stream. This option will cause a write to return after writing a single TLS record instead.

pub const ACCEPT_MOVING_WRITE_BUFFER: SslMode

Disables a check that the data buffer has not moved between calls when operating in a nonblocking context.

pub const AUTO_RETRY: SslMode

Enables automatic retries after TLS session events such as renegotiations or heartbeats.

By default, OpenSSL will return a WantRead error after a renegotiation or heartbeat. This option will cause OpenSSL to automatically continue processing the requested operation instead.

Note that SslStream::read and SslStream::write will automatically retry regardless of the state of this option. It only affects SslStream::ssl_read and SslStream::ssl_write.

pub const NO_AUTO_CHAIN: SslMode

Disables automatic chain building when verifying a peer's certificate.

TLS peers are responsible for sending the entire certificate chain from the leaf to a trusted root, but some will incorrectly not do so. OpenSSL will try to build the chain out of certificates it knows of, and this option will disable that behavior.

pub const RELEASE_BUFFERS: SslMode

Release memory buffers when the session does not need them.

This saves ~34 KiB of memory for idle streams.

pub const SEND_FALLBACK_SCSV: SslMode

Sends the fake TLS_FALLBACK_SCSV cipher suite in the ClientHello message of a handshake.

This should only be enabled if a client has failed to connect to a server which attempted to downgrade the protocol version of the session.

Do not use this unless you know what you're doing!

pub const fn empty() -> SslMode

Returns an empty set of flags

pub const fn all() -> SslMode

Returns the set containing all flags.

pub const fn bits(&self) -> c_long

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: c_long) -> Option<SslMode>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: c_long) -> SslMode

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: c_long) -> SslMode

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: SslMode) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: SslMode) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: SslMode)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: SslMode)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: SslMode)

Toggles the specified flags in-place.

pub fn set(&mut self, other: SslMode, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for SslMode

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl BitAnd<SslMode> for SslMode

type Output = SslMode

The resulting type after applying the & operator.

fn bitand(self, other: SslMode) -> SslMode

Returns the intersection between the two sets of flags.

impl BitAndAssign<SslMode> for SslMode

fn bitand_assign(&mut self, other: SslMode)

Disables all flags disabled in the set.

impl BitOr<SslMode> for SslMode

type Output = SslMode

The resulting type after applying the | operator.

fn bitor(self, other: SslMode) -> SslMode

Returns the union of the two sets of flags.

impl BitOrAssign<SslMode> for SslMode

fn bitor_assign(&mut self, other: SslMode)

Adds the set of flags.

impl BitXor<SslMode> for SslMode

type Output = SslMode

The resulting type after applying the ^ operator.

fn bitxor(self, other: SslMode) -> SslMode

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<SslMode> for SslMode

fn bitxor_assign(&mut self, other: SslMode)

Toggles the set of flags.

impl Clone for SslMode

fn clone(&self) -> SslMode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for SslMode

impl Debug for SslMode

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for SslMode

impl Extend<SslMode> for SslMode

fn extend<T: IntoIterator<Item = SslMode>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl FromIterator<SslMode> for SslMode

fn from_iter<T: IntoIterator<Item = SslMode>>(iterator: T) -> SslMode

Creates a value from an iterator.

impl Hash for SslMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for SslMode

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Not for SslMode

type Output = SslMode

The resulting type after applying the ! operator.

fn not(self) -> SslMode

Returns the complement of this set of flags.

impl Octal for SslMode

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Ord for SslMode

fn cmp(&self, other: &SslMode) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<SslMode> for SslMode

fn eq(&self, other: &SslMode) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SslMode) -> bool

This method tests for !=.

impl PartialOrd<SslMode> for SslMode

fn partial_cmp(&self, other: &SslMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &SslMode) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &SslMode) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &SslMode) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &SslMode) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for SslMode

impl StructuralPartialEq for SslMode

impl Sub<SslMode> for SslMode

type Output = SslMode

The resulting type after applying the - operator.

fn sub(self, other: SslMode) -> SslMode

Returns the set difference of the two sets of flags.

impl SubAssign<SslMode> for SslMode

fn sub_assign(&mut self, other: SslMode)

Disables all flags enabled in the set.

impl UpperHex for SslMode

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.