Skip to main content

Framed

Struct Framed 

Source
pub struct Framed<S> { /* private fields */ }
Expand description

Bounded framing with reusable scratch storage. The first four bytes are the encoded body length in little endian, not a native Rust struct layout. A framing/I/O error poisons this codec: reconnect instead of retrying bytes.

Implementations§

Source§

impl<S: Read + Write> Framed<S>

Source

pub fn new(io: S, limit: u32) -> Result<Self>

Construct a frame codec; normally use Session::connect or Session::accept.

Source

pub fn send<M: Message>(&mut self, message: &M) -> Result<()>

Encode one complete bounded message and flush it. No automatic retries.

Source

pub fn receive<M: Message + Default>(&mut self) -> Result<M>

Read exactly one message without consuming bytes from the next frame. An oversized header is rejected before allocating its advertised size.

Auto Trait Implementations§

§

impl<S> Freeze for Framed<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for Framed<S>
where S: RefUnwindSafe,

§

impl<S> Send for Framed<S>
where S: Send,

§

impl<S> Sync for Framed<S>
where S: Sync,

§

impl<S> Unpin for Framed<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for Framed<S>
where S: UnsafeUnpin,

§

impl<S> UnwindSafe for Framed<S>
where S: 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.

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.