Struct Finished

pub struct Finished<'b, O, P: ReadPrecision> {
    buffer: &'b mut Buffer<P>,
    output: O,
}

Available on crate features proxy-handshake or client-handshake only.

A completed handshake

Represents:

• Handshake::Output, a value representing the meaning of the completed protocol exchange.
• Possibly, some data which was received, but didn’t form part of the protocol.

Fields

buffer: &'b mut Buffer<P>

The buffer

output: O

Details of the completed handshake:

Implementations

impl<'b, O> Finished<'b, O, PreciseReads>

pub fn into_output(self) -> Result<O, Bug>

Return (just) the output of the completed handshake

Available only if the Buffer was constructed with Buffer::new_precise() (or equivalent).

impl<'b, O, P: ReadPrecision> Finished<'b, O, P>

pub fn into_output_and_slice(self) -> (O, &'b [u8])

Return the output, and the following already-read data as a slice

(After callin gthis, the following already-read data will no longer be in the Buffer.)

pub fn into_output_and_vec(self) -> (O, Vec<u8>)

Return the output, and the following already-read data as a Vec

The Vec is quite likely to have a considerably larger capacity than contents. (Its capacity is usually the original buffer size, when the Buffer was created.)

The Buffer should not be discarded after calling this; it will not be usable.

pub fn into_output_forbid_pipelining(self) -> Result<O, Error>

Return the output of the completed handshake, declaring any readahead a protocol error

This function is appropriate when the peer is not supposed to send data until the handshake is complete. If data did arrive before then, and was read, we call it a protocol error, Error::ForbiddenPipelining.

Trait Implementations

impl<'b, O: Debug, P: Debug + ReadPrecision> Debug for Finished<'b, O, P>

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

Formats the value using the given formatter.