Struct cml::Environment

pub struct Environment {
    pub name: Name,
    pub extends: Option<EnvironmentExtends>,
    pub runners: Option<Vec<RunnerRegistration>>,
    pub resolvers: Option<Vec<ResolverRegistration>>,
    pub debug: Option<Vec<DebugRegistration>>,
    pub stop_timeout_ms: Option<StopTimeoutMs>,
}

Example:

environments: [
    {
        name: "test-env",
        extends: "realm",
        runners: [
            {
                runner: "gtest-runner",
                from: "#gtest",
            },
        ],
        resolvers: [
            {
                resolver: "full-resolver",
                from: "parent",
                scheme: "fuchsia-pkg",
            },
        ],
    },
],

Fields

name: Name

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

extends: Option<EnvironmentExtends>

How the environment should extend this realm’s environment.

• realm: Inherit all properties from this component’s environment.
• none: Start with an empty environment, do not inherit anything.

runners: Option<Vec<RunnerRegistration>>

The runners registered in the environment. An array of objects with the following properties:

resolvers: Option<Vec<ResolverRegistration>>

The resolvers registered in the environment. An array of objects with the following properties:

debug: Option<Vec<DebugRegistration>>

Debug protocols available to any component in this environment acquired through use from debug.

stop_timeout_ms: Option<StopTimeoutMs>

The number of milliseconds to wait, after notifying a component in this environment that it should terminate, before forcibly killing it. This field is required if the environment extends from none.

Implementations

impl Environment

pub fn merge_from(&mut self, other: &mut Self) -> Result<(), Error>

Trait Implementations

impl Debug for Environment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Environment

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl MarkdownReferenceDocGenerator for Environment

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 Environment

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

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 Environment