Struct Component

pub struct Component {
    pub url: Option<String>,
    pub decl: Option<Data>,
    pub package: Option<Package>,
    pub config_values: Option<Data>,
    pub resolution_context: Option<Context>,
    pub abi_revision: Option<u64>,
    /* private fields */
}

A component is a unit of executable software.

This object provides the component’s declaration, access to its package’s content, and relevant metadata as resolved fuchsia.component.resolution.Resolver.

Fields

url: Option<String>

The resolved URL of the component. This is the canonical URL obtained by the component resolver after following redirects and resolving relative paths.

decl: Option<Data>

Binary representation of the component’s declaration (fuchsia.component.decl.Component). This information is typically obtained from the component’s manifest or generated by the component resolver.

package: Option<Package>

The package that contains the component. By convention, the component’s package is mapped to “/pkg” in its namespace at runtime.

This is null if the component is not represented as a package. In that case, it is the runner’s responsibility to load the component’s resource from the resolved_url. This mechanism is used for web applications.

Most runners, including but not limited to the builtin ELF runner, require the package’s directory connection to have OPEN_RIGHT_EXECUTABLE rights in order to run the resolved component.

config_values: Option<Data>

Binary representation of the component’s configuration values (fuchsia.component.config.ValuesData).

resolution_context: Option<Context>

The context used to resolve component_urls relative to this component. Pass this value to Resolver::ResolveWithContext() when resolving a component URL that may be relative to this Component.

The resolution_context is an opaque value (from the perspective of component resolution) that is provided by a component Resolver to save with a parent Component.

Resolvers that can resolve relative path component URLs, via ResolveWithContext, should return a resolution_context from both Resolve and ResolveWithContext. Relative path component URLs can only be resolved via ResolveWithContext, which requires a valid resolution Context.

abi_revision: Option<u64>

The target ABI revision of the resolved component.

Trait Implementations

impl Debug for Component

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

Formats the value using the given formatter.

impl Decode<Component, DefaultFuchsiaResourceDialect> for Component

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 Component

fn default() -> Component

Returns the “default value” for a type.

impl Encode<Component, DefaultFuchsiaResourceDialect> for &mut Component

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 Component

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

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

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 Component

type Owned = Component

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 Component

impl StructuralPartialEq for Component