compio::ws::tungstenite::handshake::machine

Struct HandshakeMachine

pub struct HandshakeMachine<Stream> { /* private fields */ }

Available on crate features ws and handshake only.

Expand description

A generic handshake state machine.

Implementations§

§

impl<Stream> HandshakeMachine<Stream>

pub fn start_read(stream: Stream) -> HandshakeMachine<Stream>

Start reading data from the peer.

pub fn start_write<D>(stream: Stream, data: D) -> HandshakeMachine<Stream>
where D: Into<Vec<u8>>,

Start writing data to the peer.

pub fn get_ref(&self) -> &Stream

Returns a shared reference to the inner stream.

pub fn get_mut(&mut self) -> &mut Stream

Returns a mutable reference to the inner stream.

§

impl<Stream> HandshakeMachine<Stream>
where Stream: Read + Write,

pub fn single_round<Obj>(self) -> Result<RoundResult<Obj, Stream>, Error>
where Obj: TryParse,

Perform a single handshake round.

Trait Implementations§

§

impl<Stream> Debug for HandshakeMachine<Stream>
where Stream: Debug,

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<Stream> Freeze for HandshakeMachine<Stream>
where Stream: Freeze,

§

impl<Stream> RefUnwindSafe for HandshakeMachine<Stream>
where Stream: RefUnwindSafe,

§

impl<Stream> UnwindSafe for HandshakeMachine<Stream>
where Stream: UnwindSafe,

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 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§