Struct fidl_fuchsia_audio::Packet

pub struct Packet {
    pub payload: Option<PayloadRange>,
    pub timestamp: Option<Timestamp>,
    pub capture_timestamp: Option<i64>,
    pub flags: Option<PacketFlags>,
    pub front_frames_to_drop: Option<u32>,
    pub back_frames_to_drop: Option<u32>,
    pub encryption_properties: Option<PacketEncryptionProperties>,
    /* private fields */
}

Describes a packet delivered via StreamSink.

Fields

payload: Option<PayloadRange>

Location of the payload for this packet. This field is required.

timestamp: Option<Timestamp>

Timestamp indicating when this packet should be presented. Omitting this field implies an unspecified_best_effort timestamp.

capture_timestamp: Option<i64>

Capture time for this packet as a system monotonic time value. This field is optional and may be set by capturers to indicate when this packet was captured.

flags: Option<PacketFlags>

Flags describing the packet. Omitting this field implies all flags are clear.

front_frames_to_drop: Option<u32>

Indicates how many frames should be dropped from the front of the output packet produced by a decoder from this input packet. This value should only be provided for compressed streams. If this field is omitted, no front frames should be dropped.

back_frames_to_drop: Option<u32>

Indicates how many frames should be dropped from the back of the output packet produced by a decoder from this input packet. This value should only be provided for compressed streams. If this field is omitted, no back frames should be dropped.

encryption_properties: Option<PacketEncryptionProperties>

Describes the encryption applied to this packet. Omitting this field implies the packet is not encrypted.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl Decode<Packet> for Packet

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 Default for Packet

fn default() -> Packet

Returns the “default value” for a type.

impl Encode<Packet> for &Packet

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 for Packet

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

type Owned = Packet

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 Packet

type Borrowed<'a> = &'a Packet

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 Persistable for Packet

impl StructuralPartialEq for Packet