Skip to main content

FrameWriter

Struct FrameWriter 

Source
pub struct FrameWriter<W> { /* private fields */ }
Expand description

Async frame writer over any AsyncWrite stream.

Implementations§

Source§

impl<W: AsyncWrite + Unpin> FrameWriter<W>

Source

pub fn new(inner: W) -> Self

Wrap a writer.

Source

pub async fn write_frame(&mut self, frame: &Frame) -> Result<(), TransportError>

Write a frame to the stream.

Source

pub async fn write_data(&mut self, payload: &[u8]) -> Result<(), TransportError>

Write a data frame with the given payload.

Source

pub async fn write_control( &mut self, payload: &[u8], ) -> Result<(), TransportError>

Write a control frame with the given payload.

Source

pub async fn write_json<T: Serialize>( &mut self, value: &T, ) -> Result<(), TransportError>

Write a JSON-serializable value as a data frame.

Source

pub fn inner(&self) -> &W

Get a reference to the inner writer.

Source

pub fn into_inner(self) -> W

Consume the writer and return the inner stream.

Trait Implementations§

Source§

impl<W: Debug> Debug for FrameWriter<W>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<W> Freeze for FrameWriter<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for FrameWriter<W>
where W: RefUnwindSafe,

§

impl<W> Send for FrameWriter<W>
where W: Send,

§

impl<W> Sync for FrameWriter<W>
where W: Sync,

§

impl<W> Unpin for FrameWriter<W>
where W: Unpin,

§

impl<W> UnsafeUnpin for FrameWriter<W>
where W: UnsafeUnpin,

§

impl<W> UnwindSafe for FrameWriter<W>
where W: 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 = 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.