Crate fidl_fuchsia_component_decl

Macros

CapabilityUnknown

Pattern that matches an unknown Capability member.

ConfigChecksumUnknown

Pattern that matches an unknown ConfigChecksum member.

ConfigSingleValueUnknown

Pattern that matches an unknown ConfigSingleValue member.

ConfigTypeLayoutUnknown

Pattern that matches an unknown ConfigTypeLayout member.

ConfigValueSourceUnknown

Pattern that matches an unknown ConfigValueSource member.

ConfigValueUnknown

Pattern that matches an unknown ConfigValue member.

ConfigVectorValueUnknown

Pattern that matches an unknown ConfigVectorValue member.

DebugRegistrationUnknown

Pattern that matches an unknown DebugRegistration member.

DeliveryTypeUnknown

Pattern that matches an unknown DeliveryType member.

ExposeUnknown

Pattern that matches an unknown Expose member.

LayoutConstraintUnknown

Pattern that matches an unknown LayoutConstraint member.

LayoutParameterUnknown

Pattern that matches an unknown LayoutParameter member.

OfferUnknown

Pattern that matches an unknown Offer member.

RefUnknown

Pattern that matches an unknown Ref member.

UseUnknown

Pattern that matches an unknown Use member.

Structs

CapabilityRef

A reference to a capability declared in this component.

Child

Statically declares a child component instance.

ChildRef

A reference to one of the component’s child instances.

Collection

Statically declares a component instance collection.

CollectionRef

A reference to one of the component’s collections.

Component

A component declaration.

ConfigField

Declares a single config field (key + type)

ConfigMutability

Allowed sources for runtime overrides of a config field’s value.

ConfigOverride

A directive to override the value of a particular configuration field in the child.

ConfigSchema

The schema of a component’s configuration interface.

ConfigSourceCapabilities

ConfigType

ConfigValueSpec

An individual configuration value. It is matched against a specific configuration field based on its offset within ValuesData.values.

ConfigValuesData

Contents of the configuration value file. Defines the base values for a component’s config.

Configuration

Declares a configuration capability.

DebugProtocolRegistration

Registers a protocol in the environment as a debug capability. This makes it available to any component in the environment that uses it with source == debug.

DebugRef

A reference to the environment’s debug capabilities.

Dictionary

Declares a dictionary capability.

Directory

Declares a directory capability backed by this component.

Environment

Declares an environment which configures a realm.

EnvironmentRef

A reference to the environment.

EventStream

Declares an event_stream capability

EventSubscription

Indicates the event name to subscribe to with a given event mode.

ExposeConfiguration

Declares a configuration capability exposed to a component’s containing realm, such as a capability exposed by the component or one of its children at runtime.

ExposeDictionary

Declares a dictionary exposed to a component’s containing realm, such as a dictionary exposed by the component or one of its children at runtime.

ExposeDirectory

Declares a directory exposed to a component’s containing realm, such as a directory exposed by the component or one of its children at runtime.

ExposeProtocol

Declares a protocol exposed to a component’s containing realm, such as a protocol exposed by the component or one of its children at runtime.

ExposeResolver

Declares a resolver exposed to a component’s containing realm, such as a resolver exposed by the component or one of its children at runtime.

ExposeRunner

Declares a runner exposed to a component’s containing realm, such as a runner exposed by the component or one of its children at runtime.

ExposeService

Declares a service exposed to a component’s containing realm, such as a service exposed by the component or one of its children at runtime.

FrameworkRef

A reference to the component framework itself.

NameMapping

Type used to create a mapping between 2 names. Used to rename service or component instances in FIDL declarations.

OfferConfiguration

Declares a configuration capability offered by a component to one of its children, which may have been offered by the component’s containing realm, the component itself, or one of its other children.

OfferDictionary

Declares a dictionary offered by a component to one of its children, which may have been offered by the component’s containing realm, the component itself, or one of its other children.

OfferDirectory

Declares a directory offered by a component to one of its children, which may have been offered by the component’s containing realm, the component itself, or one of its other children.

OfferEventStream

Declares an event stream offered by a component.

OfferProtocol

Declares a protocol offered by a component to one of its children, which may have been offered by the component’s containing realm, the component itself, or one of its other children.

OfferResolver

Declares a resolver capability offered by a component to one of its children, which may have been offered by the component’s containing realm, the component itself, or one of its other children.

OfferRunner

Declares a runner offered by a component to one of its children, which may have been offered by the component’s containing realm, the component itself, or one of its other children.

OfferService

Declares a service offered by a component to one of its children, which may have been offered by the component’s containing realm, the component itself, or one of its other children.

OfferStorage

Declares a storage capability offered by a component to one of its children, such as meta storage offered by the component’s containing realm or cache storage offered by the component itself.

ParentRef

A reference to a component’s parent instance.

Program

A program declaration.

Protocol

Declares a protocol capability backed by this component.

ResolvedConfig

A configuration that has been completely resolved by component manager.

ResolvedConfigField

Resolver

Declares a resolver which is responsible for resolving component URLs to actual components. See fuchsia.component.resolution.Resolver for the protocol resolvers are expected to implement.

ResolverRegistration

A mapping of URL scheme to resolver name.

Runner

Declares a runner capability backed by a service.

RunnerRegistration

A repository of the runners available in an environment.

SelfRef

A reference to the component itself.

Service

Declares a service capability backed by this component.

Storage

Declares a storage capability backed by a directory from which data, cache, or meta storage can be offered.

UseConfiguration

UseDirectory

Declares a directory used by a component, which was offered to it.

UseEventStream

Declares an EventStream used by a component.

UseProtocol

Declares a protocol used by a component, which was offered to it.

UseRunner

Declares runner used by a component.

UseService

Declares a service used by a component, which was offered to it.

UseStorage

Declares storage used by a component, which was offered to it.

VoidRef

A reference to an intentionally missing offer source.

Enums

AllowedOffers

The kinds of offers that can target the children in a collection.

Availability

Describes the expected availability of the capability.

Capability

Declares a capability defined by this component.

ConfigChecksum

The checksum produced for a configuration interface. Two configuration interfaces are the same if their checksums are the same.

ConfigSingleValue

A single configuration value.

ConfigTypeLayout

ConfigValue

A configuration value which can be provided to a component.

ConfigValueSource

Strategies available for resolving configuration values.

ConfigVectorValue

A vector configuration value.

DebugRegistration

Declares a capability registered in the debug section of an environment.

DeliveryType

DeliveryType may be used when declaring a capability, and specifies under what conditions the framework will open the capability from the provider component’s outgoing directory when there is a request for this capability.

DependencyType

Describes the type of dependency implied by the capability.

Durability

The durability of component instances created in a collection.

EnvironmentExtends

Specifies how a declared environment’s initial set of properties are assigned.

Expose

Declares a capability exposed to either a component’s containing realm or to the framework. For example, a legacy service exposed by the component at runtime.

LayoutConstraint

LayoutParameter

Offer

Declares a capability offered by a component to one of its children, which may have been offered by the component’s containing realm, the component itself, or one of its other children.

OnTerminate

Describes the action to take if this component instance terminates unexpectedly.

Ref

A reference to a capability source or destination relative to this component.

StartupMode

Describes under what conditions the component may be started.

StorageId

Declares which identifier to use to key a component’s isolated storage directory.

Use

Declares a capability used by a component, which was offered to it.

Constants

CONFIG_KEY_MAX_SIZE

Config keys can only consist of these many bytes

MAX_CHILD_NAME_LENGTH

MAX_MONIKER_LENGTH

MAX_NAME_LENGTH

MAX_NUM_EVENT_STREAM_SUBSCRIPTIONS

The maximum number of EventSubscriptions in an EventStream.

MAX_PATH_LENGTH

MAX_URL_SCHEME_LENGTH

Type Aliases

ChildName

ConfigKey

The string identifier for a config field.

DictionaryPath

Path in a dictionary. The format is similar to a directory path, except no . or ... is allowed and each path segment must conform to the format of the name type.

Name

UrlScheme