Struct Heap

pub struct Heap {
    pub heap_type: Option<String>,
    pub id: Option<u64>,
    /* private fields */
}

A reference to a heap instance.

A given heap instance can have more than one Heap which can be used to refer to the heap instance. Comparing Heap tables without knowledge of these Heap aliases is not a reliable way to determine if two Heap tables refer to the same heap (matching means yes, but not matching means maybe). Allowing heap aliases makes renaming Heap.type(s) easier.

Fields

heap_type: Option<String>

The type of the heap, specified using a bind string defined per the schema and mechanism described in comments in the fuchsia.sysmem.heap.bind file.

Examples:

• “fuchsia.sysmem.heap.HEAP_TYPE.SYSTEM_RAM”
• “fuchsia.goldfish.platform.sysmem.heap.HEAP_TYPE.HOST_VISIBLE”

id: Option<u64>

The uint64 id of the heap. This is only required to be unique per (type, boot) tuple. In other words, a given heap id is only meaningful within the current boot of the machine (not across boots), and only within the Heap.type.

For Heap.type(s) that refer to a singleton heap, a participant specifying the singleton heap in [fuchsia.sysmem2.BufferMemoryConstraints.permitted_heaps] can leave this field un-set, or set it to zero. Sysmem will always fill out this field for the heap indicated in [fuchsia.sysmem2.BufferMemmorySettings.heap] (for a singleton heap the id field will be set to 0 by sysmem).

Trait Implementations

impl Clone for Heap

fn clone(&self) -> Heap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Heap

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

Formats the value using the given formatter.

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

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 Heap

fn default() -> Heap

Returns the “default value” for a type.

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

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 Heap

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

type Owned = Heap

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 Heap

type Borrowed<'a> = &'a Heap

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 Heap

impl StructuralPartialEq for Heap