Skip to main content

NeedsInput

Struct NeedsInput 

Source
pub struct NeedsInput<Side: SideData>(/* private fields */);
Expand description

More data needs to be supplied to make progress.

Provide the data to Self::process().

Implementations§

Source§

impl<Side: SideData> NeedsInput<Side>

Source

pub fn process( self, input: &mut dyn TlsInputBuffer, tls: &mut Vec<u8>, ) -> Result<Side::Handshake, Error>

Progress the handshake by receiving further data.

The data is obtained via input. Any output produced is appended to tls and should be sent to the peer (including if this function returns an error, because tls may contain an alert.)

An error from this function is otherwise fatal to the connection, as it consumes the NeedsInput object.

On success, this returns a handshake object specifying what to do to progress the connection. If this contains another NeedsInput object then obtaining more input (eg, from a socket or other source) is certainly necessary.

Source

pub fn early_exporter(&mut self) -> Result<KeyingMaterialExporter, Error>

Returns the “early” exporter that can derive key material for use in early data

See RFC 5705 for general details on what exporters are, and RFC 9846 S7.5 for specific details on the “early” exporter.

Beware that the early exporter requires care, as it is subject to the same potential for replay as early data itself. See RFC 9846 appendix F.5.1 for more detail.

This function can be called at most once per connection. This function will error if called more than once per connection.

If you are looking for the normal exporter, this is available from Connection::exporter().

Source§

impl NeedsInput<ClientSide>

Source

pub fn early_data(&mut self) -> Option<WriteEarlyData<'_>>

Returns an object you can use to send TLS1.3 early data (a.k.a. “0-RTT data”) to the server.

This returns None in many circumstances when the capability to send early data is not available, including but not limited to:

  • The server hasn’t been talked to previously.
  • The server does not support resumption.
  • The server does not support early data.
  • The resumption data for the server has expired.

The server specifies a maximum amount of early data. You can learn this limit through the returned object, and writes through it will process only this many bytes.

The server can choose not to accept any sent early data – in this case the data is lost but the connection continues. You can tell this happened using ClientSide::is_early_data_accepted().

Trait Implementations§

Source§

impl<S: SideData> Debug for NeedsInput<S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<Side> !RefUnwindSafe for NeedsInput<Side>

§

impl<Side> !UnwindSafe for NeedsInput<Side>

§

impl<Side> Freeze for NeedsInput<Side>
where Connection<Side, Tcp>: Freeze,

§

impl<Side> Send for NeedsInput<Side>
where Connection<Side, Tcp>: Send,

§

impl<Side> Sync for NeedsInput<Side>
where Connection<Side, Tcp>: Sync,

§

impl<Side> Unpin for NeedsInput<Side>
where Connection<Side, Tcp>: Unpin,

§

impl<Side> UnsafeUnpin for NeedsInput<Side>
where Connection<Side, Tcp>: UnsafeUnpin,

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
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.

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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