Skip to main content

FrameStreamEncoder

Struct FrameStreamEncoder 

Source
pub struct FrameStreamEncoder<F>
where F: FnMut(&[u8]),
{ /* private fields */ }
Expand description

Encodes a stream of bytes into framed messages.

Each frame is emitted with proper metadata. Frames are emitted when enough data is buffered or when explicitly flushed. Optionally, a callback can be registered to observe each encoded frame.

Implementations§

Source§

impl<F> FrameStreamEncoder<F>
where F: FnMut(&[u8]),

Source

pub fn new( stream_id: u32, max_chunk_size: usize, on_emit: F, ) -> FrameStreamEncoder<F>

Creates a new encoder with the given stream ID and payload limit.

An optional on_emit callback will be invoked with every emitted frame (as raw encoded bytes).

Source

pub fn write_bytes(&mut self, data: &[u8]) -> Result<usize, FrameEncodeError>

Accepts some bytes, returns zero or more encoded frames (ready to send). Buffers any leftover partial chunk internally.

Source

pub fn flush(&mut self) -> Result<usize, FrameEncodeError>

Flushes remaining buffered data as a final frame (could be partial).

Source

pub fn end_stream(&mut self) -> Result<usize, FrameEncodeError>

Returns an End frame, even if no data was ever sent.

Source

pub fn cancel_stream(&mut self) -> Result<usize, FrameEncodeError>

Emits a Cancel frame for this stream.

Auto Trait Implementations§

§

impl<F> Freeze for FrameStreamEncoder<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for FrameStreamEncoder<F>
where F: RefUnwindSafe,

§

impl<F> Send for FrameStreamEncoder<F>
where F: Send,

§

impl<F> Sync for FrameStreamEncoder<F>
where F: Sync,

§

impl<F> Unpin for FrameStreamEncoder<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for FrameStreamEncoder<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for FrameStreamEncoder<F>
where F: 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

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 = 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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more