Struct UsbPacketBuilder

Source
pub struct UsbPacketBuilder<B> { /* private fields */ }
Expand description

Builds an aggregate usb packet out of vsock packets and gives readiness notifications when there is room to add another packet or data available to send.

Implementations§

Source§

impl<B> UsbPacketBuilder<B>

Source

pub fn new(buffer: B) -> Self

Creates a new builder from buffer, which is a type that can be used as a mutable slice with space available for storing vsock packets. The readable_notify will have a message sent to it whenever a usb packet could be transmitted.

Source

pub fn has_data(&self) -> bool

Returns true if the packet has data in it

Source§

impl<B> UsbPacketBuilder<B>
where B: DerefMut<Target = [u8]>,

Source

pub fn available(&self) -> usize

Gets the space currently available for another packet in the buffer

Source

pub fn write_vsock_packet( &mut self, packet: &Packet<'_>, ) -> Result<(), PacketTooBigError>

Writes the given packet into the buffer. The packet and header must be able to fit within the buffer provided at creation time.

Source

pub fn take_usb_packet(&mut self) -> Option<&mut [u8]>

Takes the current usb packet, if there is one. The returned mutable slice will be only the data written to the buffer so far, and packet writing will be reset to the beginning of the buffer.

Auto Trait Implementations§

§

impl<B> !Freeze for UsbPacketBuilder<B>

§

impl<B> !RefUnwindSafe for UsbPacketBuilder<B>

§

impl<B> Send for UsbPacketBuilder<B>
where B: Send,

§

impl<B> Sync for UsbPacketBuilder<B>
where B: Sync,

§

impl<B> Unpin for UsbPacketBuilder<B>
where B: Unpin,

§

impl<B> UnwindSafe for UsbPacketBuilder<B>
where B: 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.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.