Skip to main content

Chunks

Struct Chunks 

Source
pub struct Chunks {
    pub ssn: u16,
    pub ppi: PayloadProtocolIdentifier,
    pub chunks: Vec<ChunkPayloadData>,
    /* private fields */
}
Expand description

Chunks is a set of chunks that share the same SSN

Fields§

§ssn: u16

used only with the ordered chunks

§ppi: PayloadProtocolIdentifier

The payload protocol identifier shared by every fragment of this message.

§chunks: Vec<ChunkPayloadData>

The fragments, in order, that make up one complete message.

Implementations§

Source§

impl Chunks

Source

pub fn is_empty(&self) -> bool

Whether the reassembled message carries no bytes.

Source

pub fn len(&self) -> usize

The total length in bytes of the reassembled message.

Source

pub fn to_payload(&self, max_len: usize) -> Result<BytesMut>

Reassemble all fragments into a single freshly-allocated, exactly-sized buffer with one copy.

Unlike read, this does not round-trip through a caller-provided scratch buffer, eliminating one full-payload copy on the receive path (the reassembled message would otherwise be copied into the scratch buffer and then again into the delivered BytesMut). Returns Error::ErrShortBuffer when the message exceeds max_len, mirroring read’s bound so oversized inbound messages are still rejected.

Source

pub fn read(&self, buf: &mut [u8]) -> Result<usize>

Concatenates every fragment into buf, returning the number of bytes written.

§Errors

Returns Error::ErrShortBuffer if buf cannot hold the whole message; the partial copy is left in place.

Source

pub fn next(&mut self, max_length: usize) -> Option<Chunk>

Yields the next slice of the reassembled message, up to max_length bytes.

Advances an internal cursor, so repeated calls walk the message; returns None once it is exhausted.

Trait Implementations§

Source§

impl Clone for Chunks

Source§

fn clone(&self) -> Chunks

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Chunks

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.