Struct fidl_fuchsia_component::CreateChildArgs

pub struct CreateChildArgs {
    pub numbered_handles: Option<Vec<HandleInfo>>,
    pub dynamic_offers: Option<Vec<Offer>>,
    pub controller: Option<ServerEnd<ControllerMarker>>,
    pub config_capabilities: Option<Vec<Configuration>>,
    pub dictionary: Option<ClientEnd<DictionaryMarker>>,
    /* private fields */
}

Fields

numbered_handles: Option<Vec<HandleInfo>>

The numbered handles to pass to the component instance.

If the runner for the component does not support the numbered handles it is expected to close the handles.

dynamic_offers: Option<Vec<Offer>>

Dynamic offers that will target the component instance.

Including OfferDecls in this vector will cause additional capabilities to be offered to the newly created child, beyond the OfferDecls in the parent’s ComponentDecl that target the collection.

Any kind of offer (e.g., protocol, directory) can be used as a dynamic offer. Any source that would be valid for a static offer is also valid for a dynamic offer. Additionally, unlike static offers, dynamic offers can use a “sibling” dynamic child component as a source by setting the source to a ChildRef that sets the collection field.

Dynamic offers always target the newly created child component. As a result, OfferDecls in dynamic_offers must not set the target field, as its value is implied.

If either the source (that is, the component named in the source field of the OfferDecl) or the target of a dynamic offer is destroyed, the offer itself is destroyed simultaneously.

In order to set this field to a non-empty value, the collection in which the child component is being created must specify ComponentDecl.allowed_offers = STATIC_AND_DYNAMIC.

controller: Option<ServerEnd<ControllerMarker>>

The controller for this component, which may be used to influence the component’s lifecycle.

config_capabilities: Option<Vec<Configuration>>

Configuration Capabilities that will target the component instance.

Including a Configuration in this list will add the Configuration Capability as a dynamic capability in the current realm. It will also create a dynamic offer for this capability to the child.

The dynamic offer that is created is from self to the newly created child.

If the newly created child is destroyed, both the configuration capability and its resulting dynamic offer will be destroyed.

In order to set this field to a non-empty value, the collection in which the child component is being created must specify ComponentDecl.allowed_offers = STATIC_AND_DYNAMIC.

dictionary: Option<ClientEnd<DictionaryMarker>>

A dictionary that contains extra capabilities for the component instance.

Trait Implementations

impl Debug for CreateChildArgs

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

Formats the value using the given formatter.

impl Decode<CreateChildArgs> for CreateChildArgs

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 CreateChildArgs

fn default() -> CreateChildArgs

Returns the “default value” for a type.

impl Encode<CreateChildArgs> for &mut CreateChildArgs

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 CreateChildArgs

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

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

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 CreateChildArgs

type Owned = CreateChildArgs

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

impl StructuralPartialEq for CreateChildArgs