Skip to main content

StartTlsState

Struct StartTlsState 

pub struct StartTlsState { /* private fields */ }
Expand description

Host-owned STARTTLS transition guard for one connection.

The downgrade this closes is the classic one: a negotiation that fails to upgrade, and an adapter that carries on in the clear because the connection is technically still usable. Once an upgrade begins, plaintext I/O is over whether or not the handshake succeeds.

Implementations§

Source§

impl StartTlsState

Source

pub fn new() -> Self

Begin in protocol negotiation before any credentials/application data.

Source

pub fn phase(&self) -> StartTlsPhase

Current authoritative connection phase.

Source

pub fn plaintext_negotiation_allowed(&self) -> bool

Whether protocol-specific plaintext negotiation I/O is currently legal.

Source

pub fn application_io_allowed(&self) -> bool

Whether authenticated/application I/O is currently legal.

Source

pub fn begin_upgrade(&mut self) -> Result<(), EgressError>

Commit to an in-place TLS upgrade and permanently end plaintext I/O.

§Errors

Returns EgressError::InvalidStartTlsTransition unless negotiation is still active.

Source

pub fn complete_upgrade(&mut self) -> Result<(), EgressError>

Record a successful TLS handshake.

§Errors

Returns EgressError::InvalidStartTlsTransition unless a handshake is in progress.

Source

pub fn fail_upgrade(&mut self) -> Result<(), EgressError>

Record a failed TLS handshake. The failed phase is terminal and must result in connection closure; plaintext fallback is never permitted.

§Errors

Returns EgressError::InvalidStartTlsTransition unless a handshake is in progress.

Trait Implementations§

Source§

impl Debug for StartTlsState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for StartTlsState

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more