Crate cml

A library of common utilities used by cmc and related tools. To manually regenerate reference documentation from doc comments in this file, see the instructions at:

tools/lib/reference_doc/macro/derive-reference-doc-tests/src/test_data/README.md

Re-exports

• pub use crate::one_or_many::OneOrMany;
• pub use crate::translate::compile;
• pub use crate::translate::CompileOptions;

Modules

• error
• features
• one_or_many
• translate

Structs

• Capability
• CapabilityRequirements
• Child
  Example:
• Collection
  Example:
• ConfigKey
• DebugRegistration
• DictionaryRef
  A reference to a (possibly nested) dictionary.
• Document
  Component manifest (.cml) reference
• Environment
  Example:
• Expose
  Example:
• NamespacePath
  NamespacePath is the same as Path but accepts "/" (which is also a valid namespace path).
• Offer
  Example:
• OneOrManyEventScope
  Generates deserializer for OneOrMany<UseFromRef>.
• OneOrManyExposeFromRefs
  Generates deserializer for OneOrMany<ExposeFromRef>.
• OneOrManyNames
  Generates deserializer for OneOrMany<Name>.
• OneOrManyOfferFromRefs
  Generates deserializer for OneOrMany<OfferFromRef>.
• OneOrManyOfferToRefs
  Generates deserializer for OneOrMany<OfferToRef>.
• OneOrManyPaths
  Generates deserializer for OneOrMany<Path>.
• Path
  A path type used throughout Component Framework, along with its variants NamespacePath and RelativePath. Examples of use:
• Program
• RelativePath
  Same as Path except the path does not begin with /.
• ResolverRegistration
• Rights
  A list of rights.
• RunnerRegistration
• StopTimeoutMs
  The stop timeout configured in an environment.
• Url
  A component URL. The URL is validated, but represented as a string to avoid normalization and retain the original representation.
• Use
  Example:

Enums

• AllowedOffers
  The kinds of offers that can target components in a given collection. See AllowedOffers.
• AnyRef
  A relative reference to another object. This is a generic type that can encode any supported reference subtype. For named references, it holds a reference to the name instead of the name itself.
• Availability
  Capability availability. See Availability.
• CapabilityFromRef
  A reference in a storage from.
• CapabilityId
  A name/identity of a capability exposed/offered to another component.
• ConfigNestedValueType
• ConfigRuntimeSource
• ConfigType
• ConfigValueType
• DeliveryType
  Specifies when the framework will open the protocol from the provider component’s outgoing directory when someone requests the capability. See DeliveryType.
• DependencyType
  Offered dependency type. See DependencyType.
• Durability
  The duration of child components in a collection. See Durability.
• EnvironmentExtends
• EnvironmentRef
  A reference in an environment.
• EventScope
  The scope of an event.
• ExposeFromRef
  A reference in an expose from.
• ExposeToRef
  A reference in an expose to.
• MustOfferRequirement
• MustUseRequirement
• OfferFromRef
  A reference in an offer from.
• OfferToRef
  A reference in an offer to.
• OnTerminate
  A component instance’s recovery policy. See OnTerminate.
• ParseError
  The error representing a failure to parse a type from string.
• RegistrationRef
  A reference in an environment registration.
• Right
  A right or bundle of rights to apply to a directory.
• RootDictionaryRef
  A reference to a root dictionary.
• SourceAvailability
  A reference in an offer to.
• StartupMode
  A component instance’s startup mode. See StartupMode.
• StorageId
• UseFromRef
  A reference in a use from.

Traits

• AsClause
• CapabilityClause
• FilterClause
• FromClause
• PathClause
• RightsClause

Functions

• alias_or_name
• alias_or_path
• format_cml
• offer_to_all_and_component_diff_protocols_message
• offer_to_all_and_component_diff_sources_message
• offer_to_all_would_duplicate
  Returns Ok(true) if desugaring the offer_to_all using name duplicates specific_offer. Returns Ok(false) if not a duplicate.
• parse_many_documents
  Parses a string buffer into a vector of Document. file is used for error reporting. Supports JSON encoded as an array of Document JSON objects.
• parse_one_document
  Parses a string buffer into a Document. file is used for error reporting.

Type Aliases

• Name
  A name that can refer to a component, collection, or other entity in the Component Manifest. Its length is bounded to MAX_NAME_LENGTH.