Struct Frame

pub struct Frame {
    pub frame_type: Option<FrameType>,
    pub data: Option<Vec<u8>>,
    pub meta: Option<FrameMetadata>,
    pub port: Option<u8>,
    /* private fields */
}

A frame written to or read from a [fuchsia.net.tun/Device].

Required fields must always be provided to [fuchsia.net.tun/Port.WriteFrame] and are always present when returned by [fuchsia.net.tun/Port.ReadFrame].

Fields

frame_type: Option<FrameType>

The type identifying this frame’s payload.

Required.

data: Option<Vec<u8>>

The frame’s payload.

Valid iff non-empty.

Required.

meta: Option<FrameMetadata>

Extra frame metadata.

This is an opaque holder for extra information that is associated with Network Device data frames.

If not set, interpreted as empty.

port: Option<u8>

Frame’s destination or source port identifier.

Required.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<Frame, D> for Frame

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

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

impl Default for Frame

fn default() -> Frame

Returns the “default value” for a type.

impl<D: ResourceDialect> Encode<Frame, D> for &Frame

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

fn eq(&self, other: &Frame) -> 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 TypeMarker for Frame

type Owned = Frame

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 Frame

type Borrowed<'a> = &'a Frame

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(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

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

impl Persistable for Frame

impl StructuralPartialEq for Frame