Struct SessionInfo

pub struct SessionInfo {
    pub descriptors: Option<Vmo>,
    pub data: Option<Vmo>,
    pub descriptor_version: Option<u8>,
    pub descriptor_length: Option<u8>,
    pub descriptor_count: Option<u16>,
    pub options: Option<SessionFlags>,
    /* private fields */
}

Session configuration.

Fields

descriptors: Option<Vmo>

VMO containing the descriptors. Required.

16-bit indices transmitted over the FIFOs index a descriptor in this VMO (byte offset = descriptor_length * 8 * index).

data: Option<Vmo>

VMO containing frame data. Required.

Descriptors contain byte-offsets that are used to index arbitrary regions in data.

descriptor_version: Option<u8>

Requested descriptor version. Required.

If the network device does not support the requested descriptor version, [Device.OpenSession] fails with ZX_ERR_NOT_SUPPORTED.

descriptor_length: Option<u8>

Descriptor length, in 64-bit words. Required.

The length of each descriptor in the descriptors VMO. This is used as a multiplier to find byte offsets in descriptors given a descriptor index passed through the rx or tx FIFOs.

descriptor_count: Option<u16>

Total number of descriptors that can be used by this session. Required.

Descriptor indices transferred through either the rx or tx FIFO must be in the range [0, descriptor_count).

options: Option<SessionFlags>

Extra options. Interpreted as empty bitmask if absent.

Trait Implementations

impl Debug for SessionInfo

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

Formats the value using the given formatter.

impl Decode<SessionInfo, DefaultFuchsiaResourceDialect> for SessionInfo

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, DefaultFuchsiaResourceDialect>, offset: usize, depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for SessionInfo

fn default() -> SessionInfo

Returns the “default value” for a type.

impl Encode<SessionInfo, DefaultFuchsiaResourceDialect> for &mut SessionInfo

unsafe fn encode( self, encoder: &mut Encoder<'_, DefaultFuchsiaResourceDialect>, offset: usize, depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for SessionInfo

fn eq(&self, other: &SessionInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ResourceTypeMarker for SessionInfo

type Borrowed<'a> = &'a mut SessionInfo

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &mut Self::Owned. There are three cases:

fn take_or_borrow<'a>( value: &'a mut <Self as TypeMarker>::Owned, ) -> Self::Borrowed<'a>

Cheaply converts from &mut Self::Owned to Self::Borrowed. For HandleBased types this is “take” (it returns an owned handle and replaces value with Handle::invalid), and for all other types it is “borrow” (just converts from one reference to another).

impl TypeMarker for SessionInfo

type Owned = SessionInfo

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl Standalone<DefaultFuchsiaResourceDialect> for SessionInfo

impl StructuralPartialEq for SessionInfo