Struct fidl_fuchsia_hardware_network::DeviceBaseInfo

pub struct DeviceBaseInfo {
    pub rx_depth: Option<u16>,
    pub tx_depth: Option<u16>,
    pub buffer_alignment: Option<u32>,
    pub max_buffer_length: Option<u32>,
    pub min_rx_buffer_length: Option<u32>,
    pub min_tx_buffer_length: Option<u32>,
    pub min_tx_buffer_head: Option<u16>,
    pub min_tx_buffer_tail: Option<u16>,
    pub max_buffer_parts: Option<u8>,
    pub rx_accel: Option<Vec<RxAcceleration>>,
    pub tx_accel: Option<Vec<TxAcceleration>>,
    /* private fields */
}

Network device base info.

Fields

rx_depth: Option<u16>

Maximum number of items in rx FIFO (per session). Required.

rx_depth is calculated based on the size of the actual backing hardware rx queue.

tx_depth: Option<u16>

Maximum number of items in tx FIFO (per session). Required.

tx_depth is calculated based on the size of the actual backing hardware tx queue.

buffer_alignment: Option<u32>

Alignment requirement for buffers in the data VMO.

All buffers in the data VMO must be aligned to buffer_alignment relative to the start of the VMO. buffer_alignment == 0 is never reported. Required.

max_buffer_length: Option<u32>

Maximum supported length of buffers in the data VMO, in bytes.

Absent if no maximum buffer length is defined. Must be nonzero.

min_rx_buffer_length: Option<u32>

The minimum rx buffer length required for device. Required.

min_tx_buffer_length: Option<u32>

The minimum tx buffer length required for the device. Required.

This value accounts only for tx payload length, min_tx_buffer_head and min_tx_buffer_tail are not part of this value.

Clients must zero pad outgoing frames to meet the required minimum length.

min_tx_buffer_head: Option<u16>

The number of bytes the device requests be free as head space in a tx buffer. Required.

min_tx_buffer_tail: Option<u16>

The amount of bytes the device requests be free as tail space in a tx buffer. Required.

max_buffer_parts: Option<u8>

Maximum descriptor chain length accepted by the device. Required.

rx_accel: Option<Vec<RxAcceleration>>

Available rx acceleration flags for this device.

rx_accel maps the RX_ACCEL_* flags in the frame descriptors with semantic acceleration features described by RxAcceleration. Position n of rx_accel conveys the meaning of the RX_ACCEL_n flag.

Interpreted as empty if not provided.

tx_accel: Option<Vec<TxAcceleration>>

Available tx acceleration flags for this device.

tx_accel maps the TX_ACCEL_* flags in the frame descriptors with semantic acceleration features described by TxAcceleration. Position n of tx_accel conveys the meaning of the TX_ACCEL_n flag.

Interpreted as empty if not provided.

Implementations

impl DeviceBaseInfo

pub const EMPTY: Self = _

An empty table with every field set to None.

Trait Implementations

impl Clone for DeviceBaseInfo

fn clone(&self) -> DeviceBaseInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceBaseInfo

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

Formats the value using the given formatter.

impl Decode<DeviceBaseInfo> for DeviceBaseInfo

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<'_>, offset: usize, depth: Depth ) -> Result<()>

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

impl Encode<DeviceBaseInfo> for &DeviceBaseInfo

unsafe fn encode( self, encoder: &mut Encoder<'_>, 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 Encode<DeviceBaseInfo> for DeviceBaseInfo

unsafe fn encode( self, encoder: &mut Encoder<'_>, 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<DeviceBaseInfo> for DeviceBaseInfo

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl TypeMarker for DeviceBaseInfo

type Owned = DeviceBaseInfo

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 ValueTypeMarker for DeviceBaseInfo

type Borrowed<'a> = &'a <DeviceBaseInfo as TypeMarker>::Owned

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

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

Cheaply converts from &Self::Owned to Self::Borrowed.

impl StructuralPartialEq for DeviceBaseInfo

impl TopLevel for DeviceBaseInfo