Struct Environment

pub struct Environment {
    pub name: Option<String>,
    pub extends: Option<EnvironmentExtends>,
    pub runners: Option<Vec<RunnerRegistration>>,
    pub resolvers: Option<Vec<ResolverRegistration>>,
    pub debug_capabilities: Option<Vec<DebugRegistration>>,
    pub stop_timeout_ms: Option<u32>,
    /* private fields */
}

Declares an environment which configures a realm.

Fields

name: Option<String>

(Required) The name of this environment.

extends: Option<EnvironmentExtends>

(Required) Specifies how the initial state of this environment is constructed.

runners: Option<Vec<RunnerRegistration>>

(Optional) List of runners available in this environment.

This list determines the total set of runners that are available for any component in the environment to use.

resolvers: Option<Vec<ResolverRegistration>>

(Optional) List of component resolvers and the URL schemes they are registered to resolve. These registrations determine how components are resolved in the realm. If the component URL scheme does not match any of these resolvers, URL resolution is delegated to the parent environment, if this environment extends from REALM.

debug_capabilities: Option<Vec<DebugRegistration>>

(Optional) Expose capabilities to debug section when component manager allows it.

These capabilities are accessible to any component in the environment with a use declaration with source == debug. Only capabilities intended to support development should be declared here, and they are only allowed if explicitly included in the component manager allowlist.

stop_timeout_ms: Option<u32>

(Optional) The duration in milliseconds that the component will have to stop before it is killed. Required if this environment extends from NONE.

Trait Implementations

impl Clone for Environment

fn clone(&self) -> Environment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Environment

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<Environment, D> for Environment

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for Environment

fn default() -> Environment

Returns the “default value” for a type.

impl<D: ResourceDialect> Encode<Environment, D> for &Environment

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for Environment

fn eq(&self, other: &Environment) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypeMarker for Environment

type Owned = Environment

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for Environment

type Borrowed<'a> = &'a Environment

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for Environment

impl StructuralPartialEq for Environment