Struct AllocatorGetVmoInfoResponse 

pub struct AllocatorGetVmoInfoResponse {
    pub buffer_collection_id: Option<u64>,
    pub buffer_index: Option<u64>,
    pub close_weak_asap: Option<EventPair>,
    pub weak_vmo: Option<Vmo>,
    pub single_buffer_settings: Option<SingleBufferSettings>,
    pub constraints_ok: Option<bool>,
    pub vmo_settings_match: Option<bool>,
    /* private fields */
}

Fields

buffer_collection_id: Option<u64>

The buffer_collection_id and buffer_index together uniquely identify a buffer per boot.

buffer_index: Option<u64>

The buffer_collection_id and buffer_index together uniquely identify a buffer per boot.

This buffer_index is in the same space as specified/implied by BufferCollectionInfo from collection allocation.

Clients that don’t have direct control over the provenance of vmo should assume that buffer_index could be any uint64. Such clients may wish to check the buffer_collection_id against client-known buffer collections before looking at buffer_index, and/or ensure that looking up a client-known buffer by buffer_collection_id and buffer_index doesn’t rely on buffer_index(s) being packed near 0, at least until a client-known buffer is found that the client knows will have buffer_index packed near 0.

close_weak_asap: Option<EventPair>

If vmo was a sysmem weak VMO handle or need_weak was set to true (or both), this field will be set. Later when ZX_EVENTPAIR_PEER_CLOSED is signalled on this eventpair endpoint, all weak VMO handles to this buffer should be closed asap (all strong VMO handles were already closed by this point). In some cases, a client may be able to rely on a different participant to notice and inform the client, so this field being set is potentially ignore-able by some clients.

Client authors should ensure that when the buffer’s close_weak_asap server_end closes, the client will close all handles to the buffer as soon as possible. This can be achieved directly or indirectly. Client authors should not assume that this is achieved indirectly.

weak_vmo: Option<Vmo>

Iff need_weak was set to true, this field is set to a sysmem weak VMO handle to the same sysmem buffer (assuming no Error). The koid may be different than the koid of the vmo in the request, regardless of whether vmo in the request was a strong or weak VMO handle. The weak_vmo will have no more rights than the vmo handle had. In most cases, the client should also retain close_weak_asap and notice when ZX_EVENTPAIR_PEER_CLOSED is signalled and close the weak_vmo (and any handles to child VMOs) ASAP.

single_buffer_settings: Option<SingleBufferSettings>

Iff need_single_buffer_settings is set, this field will be set to the SingleBufferSettings of the vmo’s collection. See also [fuchsia.sysmem2/Allocator.GetVmoInfo] need_single_buffer_settings.

constraints_ok: Option<bool>

Iff constraints_to_check was set, this field will be set. If true, the vmo conforms to constraints_to_check. If false, the vmo does not conform to constraints_to_check.

vmo_settings_match: Option<bool>

Iff vmo_settings_to_check was set, this field will be set. If true, vmo and vmo_settings_to_check have the same SingleBufferSettings. If false, vmo and vmo_settings_to_check have different SingleBufferSettings. The reason for not matching may not be visible to the client if SingleBufferSettings has a new field or similar.

Trait Implementations

impl Debug for AllocatorGetVmoInfoResponse

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

Formats the value using the given formatter.

impl Decode<AllocatorGetVmoInfoResponse, DefaultFuchsiaResourceDialect> for AllocatorGetVmoInfoResponse

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 AllocatorGetVmoInfoResponse

fn default() -> AllocatorGetVmoInfoResponse

Returns the “default value” for a type.

impl Encode<AllocatorGetVmoInfoResponse, DefaultFuchsiaResourceDialect> for &mut AllocatorGetVmoInfoResponse

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 AllocatorGetVmoInfoResponse

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

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

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 AllocatorGetVmoInfoResponse

type Owned = AllocatorGetVmoInfoResponse

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 AllocatorGetVmoInfoResponse

impl StructuralPartialEq for AllocatorGetVmoInfoResponse