Struct Collection

pub struct Collection {
    pub name: Option<String>,
    pub durability: Option<Durability>,
    pub environment: Option<String>,
    pub allowed_offers: Option<AllowedOffers>,
    pub allow_long_names: Option<bool>,
    pub persistent_storage: Option<bool>,
    /* private fields */
}

Statically declares a component instance collection.

Fields

name: Option<String>

(Required) The name of the collection. Instances created in the collection are scoped to this name.

durability: Option<Durability>

(Required) The durability of instances in the collection.

environment: Option<String>

(Optional) The environment assigned to child instances in this collection.

May be unset, in which case children in this collection will inherit the parent component’s environment. If set, the name must reference an environment defined in the ComponentDecl and it must contain only the following characters: [a-z0-9-_.].

allowed_offers: Option<AllowedOffers>

(Optional, defaults to STATIC_ONLY) The kinds of offers that can target the child instances in this collection.

Only components using the dynamic_offers restricted feature may set this field.

allow_long_names: Option<bool>

(Optional, defaults to false) Whether child instances in this collection can have names longer than the default length limit of 100.

Only components using the allow_long_names restricted feature may set this field.

persistent_storage: Option<bool>

(Optional) Whether the data in isolated storage used by dynamic child instances and their descendants will persist after the instances are destroyed. New dynamic instances inherit the previous instances’ data stores.

This setting can be overridden by a lower-level collection that is a descendant of a collection that enables/disables this setting.

This setting applies to all storage capabilities consumed by the collection components and their descendants.

The default is the value inherited from an ancestral collection if set, otherwise false.

Trait Implementations

impl Clone for Collection

fn clone(&self) -> Collection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Collection

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

Formats the value using the given formatter.

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

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 Collection

fn default() -> Collection

Returns the “default value” for a type.

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

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 Collection

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

type Owned = Collection

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 Collection

type Borrowed<'a> = &'a Collection

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 Collection

impl StructuralPartialEq for Collection