Struct cml::Child

pub struct Child {
    pub name: Name,
    pub url: Url,
    pub startup: StartupMode,
    pub on_terminate: Option<OnTerminate>,
    pub environment: Option<EnvironmentRef>,
}

Example:

children: [
    {
        name: "logger",
        url: "fuchsia-pkg://fuchsia.com/logger#logger.cm",
    },
    {
        name: "pkg_cache",
        url: "fuchsia-pkg://fuchsia.com/pkg_cache#meta/pkg_cache.cm",
        startup: "eager",
    },
    {
        name: "child",
        url: "#meta/child.cm",
    }
],

Fields

name: Name

The name of the child component instance, which is a string of one or more of the following characters: a-z, 0-9, _, ., -. The name identifies this component when used in a reference.

url: Url

The [component URL][component-url] for the child component instance.

startup: StartupMode

The component instance’s startup mode. One of:

• lazy (default): Start the component instance only if another component instance binds to it.
• [eager][doc-eager]: Start the component instance as soon as its parent starts.

on_terminate: Option<OnTerminate>

Determines the fault recovery policy to apply if this component terminates.

• none (default): Do nothing.
• reboot: Gracefully reboot the system if the component terminates for any reason. This is a special feature for use only by a narrow set of components; see [Termination policies][doc-reboot-on-terminate] for more information.

environment: Option<EnvironmentRef>

If present, the name of the environment to be assigned to the child component instance, one of environments. If omitted, the child will inherit the same environment assigned to this component.

Trait Implementations

impl Debug for Child

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Child

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl MarkdownReferenceDocGenerator for Child

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 Child

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

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 Child