Struct cml::Expose

pub struct Expose {

    pub service: Option<OneOrMany<Name>>,
    pub protocol: Option<OneOrMany<Name>>,
    pub directory: Option<OneOrMany<Name>>,
    pub runner: Option<OneOrMany<Name>>,
    pub resolver: Option<OneOrMany<Name>>,
    pub dictionary: Option<OneOrMany<Name>>,
    pub config: Option<OneOrMany<Name>>,
    pub from: OneOrMany<ExposeFromRef>,
    pub as: Option<Name>,
    pub to: Option<ExposeToRef>,
    pub rights: Option<Rights>,
    pub subdir: Option<RelativePath>,
    pub event_stream: Option<OneOrMany<Name>>,
    pub scope: Option<OneOrMany<EventScope>>,
    pub availability: Option<Availability>,
    pub source_availability: Option<SourceAvailability>,
}

Example:

expose: [
    {
        directory: "themes",
        from: "self",
    },
    {
        protocol: "pkg.Cache",
        from: "#pkg_cache",
        as: "fuchsia.pkg.PackageCache",
    },
    {
        protocol: [
            "fuchsia.ui.app.ViewProvider",
            "fuchsia.fonts.Provider",
        ],
        from: "self",
    },
    {
        runner: "web-chromium",
        from: "#web_runner",
        as: "web",
    },
    {
        resolver: "full-resolver",
        from: "#full-resolver",
    },
],

Fields

service: Option<OneOrMany<Name>>

When routing a service, the name of a [service capability][doc-service].

protocol: Option<OneOrMany<Name>>

When routing a protocol, the name of a [protocol capability][doc-protocol].

directory: Option<OneOrMany<Name>>

When routing a directory, the name of a [directory capability][doc-directory].

runner: Option<OneOrMany<Name>>

When routing a runner, the name of a [runner capability][doc-runners].

resolver: Option<OneOrMany<Name>>

When routing a resolver, the name of a [resolver capability][doc-resolvers].

dictionary: Option<OneOrMany<Name>>

When routing a dictionary, the name of a [dictionary capability][doc-dictionaries].

config: Option<OneOrMany<Name>>

When routing a config, the name of a configuration capability.

from: OneOrMany<ExposeFromRef>

from: The source of the capability, one of:

• self: This component. Requires a corresponding capability declaration.
• framework: The Component Framework runtime.
• #<child-name>: A reference to a child component instance.

as: Option<Name>

The name for the capability as it will be known by the target. If omitted, defaults to the original name. as cannot be used when an array of multiple capability names is provided.

to: Option<ExposeToRef>

The capability target. Either parent or framework. Defaults to parent.

rights: Option<Rights>

(directory only) the maximum [directory rights][doc-directory-rights] to apply to the exposed directory capability.

subdir: Option<RelativePath>

(directory only) the relative path of a subdirectory within the source directory capability to route.

event_stream: Option<OneOrMany<Name>>

(event_stream only) the name(s) of the event streams being exposed.

scope: Option<OneOrMany<EventScope>>

(event_stream only) the scope(s) of the event streams being exposed. This is used to downscope the range of components to which an event stream refers and make it refer only to the components defined in the scope.

availability: Option<Availability>

availability (optional): The expectations around this capability’s availability. Affects build-time and runtime route validation. One of:

• required (default): a required dependency, the source must exist and provide it. Use this when the target of this expose requires this capability to function properly.
• optional: an optional dependency. Use this when the target of the expose can function with or without this capability. The target must not have a required dependency on the capability. The ultimate source of this expose must be void or an actual component.
• same_as_target: the availability expectations of this capability will match the target’s. If the target requires the capability, then this field is set to required. If the target has an optional dependency on the capability, then the field is set to optional.
• transitional: like optional, but will tolerate a missing source. Use this only to avoid validation errors during transitional periods of multi-step code changes.

For more information, see the [availability][/docs/concepts/components/v2/capabilities/availability.md] documentation.

source_availability: Option<SourceAvailability>

Whether or not the source of this offer must exist. One of:

• required (default): the source (from) must be defined in this manifest.
• unknown: the source of this offer will be rewritten to void if its source (from) is not defined in this manifest after includes are processed.

Implementations

impl Expose

pub fn new_from(from: OneOrMany<ExposeFromRef>) -> Self

Trait Implementations

impl AsClause for Expose

fn as(&self) -> Option<&Name>

impl CapabilityClause for Expose

fn service(&self) -> Option<OneOrMany<&Name>>

fn protocol(&self) -> Option<OneOrMany<&Name>>

fn directory(&self) -> Option<OneOrMany<&Name>>

fn storage(&self) -> Option<OneOrMany<&Name>>

fn runner(&self) -> Option<OneOrMany<&Name>>

fn resolver(&self) -> Option<OneOrMany<&Name>>

fn event_stream(&self) -> Option<OneOrMany<&Name>>

fn dictionary(&self) -> Option<OneOrMany<&Name>>

fn config(&self) -> Option<OneOrMany<&Name>>

fn set_service(&mut self, o: Option<OneOrMany<Name>>)

fn set_protocol(&mut self, o: Option<OneOrMany<Name>>)

fn set_directory(&mut self, o: Option<OneOrMany<Name>>)

fn set_storage(&mut self, _o: Option<OneOrMany<Name>>)

fn set_runner(&mut self, o: Option<OneOrMany<Name>>)

fn set_resolver(&mut self, o: Option<OneOrMany<Name>>)

fn set_event_stream(&mut self, o: Option<OneOrMany<Name>>)

fn set_dictionary(&mut self, o: Option<OneOrMany<Name>>)

fn set_config(&mut self, o: Option<OneOrMany<Name>>)

fn availability(&self) -> Option<Availability>

fn set_availability(&mut self, _a: Option<Availability>)

fn capability_type(&self) -> &'static str

Returns the name of the capability for display purposes. If service() returns Some, the capability name must be “service”, etc.

fn decl_type(&self) -> &'static str

fn supported(&self) -> &[&'static str]

fn are_many_names_allowed(&self) -> bool

Returns true if this capability type allows the ::Many variant of OneOrMany.

fn names(&self) -> Vec<&Name>

Returns the names of the capabilities in this clause. If protocol() returns Some(OneOrMany::Many(vec!["a", "b"])), this returns![“a”, “b”].

fn set_names(&mut self, names: Vec<Name>)

impl Clone for Expose

fn clone(&self) -> Expose

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Expose

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Expose

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FilterClause for Expose

fn filter(&self) -> Option<&Map<String, Value>>

impl FromClause for Expose

fn from_(&self) -> OneOrMany<AnyRef<'_>>

impl MarkdownReferenceDocGenerator for Expose

fn get_reference_doc_markdown() -> String

Returns a Markdown representation of the reference docs for the struct that is derived from ReferenceDoc. The returned Markdown indents any # Markdown headers in individual field doc comments to ensure a well structured final Markdown document.

fn get_reference_doc_markdown_with_options( indent_headers_by: usize, indent_with_spaces: usize ) -> String

This method is called internally by the reference doc generator when recursing to generate documentation for field types.

impl PartialEq for Expose

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

fn path(&self) -> Option<&Path>

impl RightsClause for Expose

fn rights(&self) -> Option<&Rights>

impl Serialize for Expose

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Expose