Struct BoundPacketView 

pub struct BoundPacketView<Perms: PacketPerms> { /* private fields */ }

Bound Packet View.

Views may be bound to an output reference before being sent to the I/O backend. If the packet is bound to such output ref, then, upon completion of processing, every resulting packet view is passed to the given output ref.

Implementations

impl<Perms: PacketPerms> BoundPacketView<Perms>

pub unsafe fn forget(self)

Forget the packet

Safety

This packet must have originally been the receiver of BoundPacketView::extract_packet call. There must be one extracted packet split left.

pub unsafe fn extract_packet(&self, pos: u64, len: u64) -> Self

Extract a sub-packet from this packet

Safety

To avoid undefined behavior, the caller must ensure the following conditions are met:

1. Extracted packets do not overlap each other.

2. Entire range of self must be extracted.

3. Before the last extracted packet is dropped, self must be released with BoundPacketView::forget.

pub fn try_alloc(self) -> MaybeAlloced<Perms>

Tries allocating data for the packet view with 1 byte alignment.

pub unsafe fn unbound(&self) -> PacketView<'static, Perms>

Get an unbound Packet.

This function allows the packet to be rebound to a different I/O backend and have their results intercepted.

Safety

Please see PacketView::extract_packet documentation for details.

pub unsafe fn transfer_data( self, input: Perms::ReverseDataType, ) -> TransferredPacket<Perms>

Transfers data between the packet and the input.

If packet has Read permissions, input will be written to. If packet has Write permissions, input will be read.

If packet has ReadWrite permissions, behavior is not fully specified, but currently buffers perform memory swap operation.

Safety

The caller must ensure that input pointer is sufficient for the bounds of the packet. In addition, the data pointed by input must be properly initialized and byte-addressible.

pub fn ptr(&self) -> *const u8

Trait Implementations

impl<Perms: PacketPerms> Drop for BoundPacketView<Perms>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T: PacketPerms> Errorable for BoundPacketView<T>

fn error(self, err: Error)

impl<Perms: PacketPerms> From<BoundPacketView<Perms>> for StandardPktVariations<Perms>

fn from(p: BoundPacketView<Perms>) -> Self

Converts to this type from the input type.

impl From<BoundPacketView<Read>> for AnyPacket

fn from(p: BoundPacketView<Read>) -> Self

Converts to this type from the input type.

impl From<BoundPacketView<ReadWrite>> for AnyPacket

fn from(p: BoundPacketView<ReadWrite>) -> Self

Converts to this type from the input type.

impl<T: PacketPerms> From<BoundPacketView<T>> for ReboundPacket<T>

fn from(orig: BoundPacketView<T>) -> Self

Converts to this type from the input type.

impl From<BoundPacketView<Write>> for AnyPacket

fn from(p: BoundPacketView<Write>) -> Self

Converts to this type from the input type.

impl<T: PacketPerms> Splittable<u64> for BoundPacketView<T>

fn split_at(self, len: u64) -> (Self, Self)

Splits an object at given position.

fn len(&self) -> u64

fn is_empty(&self) -> bool