Struct FrameInfo

pub struct FrameInfo {
    pub buffer_index: Option<u32>,
    pub capture_timestamp: Option<i64>,
    pub buffer_release_token: Option<EventPair>,
    /* private fields */
}

Return fields of the [GetNextFrame] call. These fields hold the frame’s information on buffer location, timing, and a way to release after using it. All fields will be returned by the server.

Fields

buffer_index: Option<u32>

The index of the VMO where the requested frame has been rendered in the buffer collection.

capture_timestamp: Option<i64>

The time that the buffer was populated with the frame.

buffer_release_token: Option<EventPair>

The release token for |buffer_index|. The client drops the eventpair to signal to the server that |buffer_index| is free for writing. If the eventpair is not dropped, then in the future calls to [GetNextFrame], if there are no available buffers, the server will wait until the client frees up a past buffer. If the client was holding on to all buffers in the buffer collection and then releases a buffer while hanging, the server will immediately return the latest frame.

Trait Implementations

impl Debug for FrameInfo

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

Formats the value using the given formatter.

impl Decode<FrameInfo, DefaultFuchsiaResourceDialect> for FrameInfo

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 FrameInfo

fn default() -> FrameInfo

Returns the “default value” for a type.

impl Encode<FrameInfo, DefaultFuchsiaResourceDialect> for &mut FrameInfo

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 FrameInfo

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

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

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 FrameInfo

type Owned = FrameInfo

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 FrameInfo

impl StructuralPartialEq for FrameInfo