Struct FragmentQueue

Source
pub struct FragmentQueue { /* private fields */ }
Expand description

A specialized structure for re-ordering fragments over the wire. You can use this structure to fragment frames as well.

NOTE: This structure will NOT update a frame’s reliable index! The sender is required to this!

Implementations§

Source§

impl FragmentQueue

Source

pub fn new() -> Self

Source

pub fn insert( &mut self, fragment: Frame, ) -> Result<(u32, u32), FragmentQueueError>

Inserts the frame into the fragment queue. Returns a result tuple of (fragment_size, fragment_index)

Source

pub fn collect(&mut self, id: u16) -> Result<Vec<u8>, FragmentQueueError>

Attempts to collect all fragments from a given fragment id. Will fail if not all fragments are specified.

Source

pub fn split_insert( &mut self, buffer: &[u8], mtu: u16, ) -> Result<u16, FragmentQueueError>

This will split a given frame into a bunch of smaller frames within the specified restriction.

Source

pub fn split( buffer: &[u8], id: u16, mtu: u16, ) -> Result<Vec<Frame>, FragmentQueueError>

Source

pub fn get(&self, id: &u16) -> Result<&(u32, Vec<Frame>), FragmentQueueError>

Source

pub fn get_mut( &mut self, id: &u16, ) -> Result<&mut (u32, Vec<Frame>), FragmentQueueError>

Source

pub fn remove(&mut self, id: &u16) -> bool

Source

pub fn clear(&mut self)

This will hard clear the fragment queue, this should only be used if memory becomes an issue!

Trait Implementations§

Source§

impl Clone for FragmentQueue

Source§

fn clone(&self) -> FragmentQueue

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FragmentQueue

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V