Struct fidl_fuchsia_component_decl::ExposeDirectory

pub struct ExposeDirectory {
    pub source: Option<Ref>,
    pub source_name: Option<String>,
    pub target: Option<Ref>,
    pub target_name: Option<String>,
    pub rights: Option<Operations>,
    pub subdir: Option<String>,
    pub availability: Option<Availability>,
    pub source_dictionary: Option<String>,
    /* private fields */
}

Declares a directory exposed to a component’s containing realm, such as a directory exposed by the component or one of its children at runtime.

Fields

source: Option<Ref>

(Required) The provider of the capability relative to the component itself. Must be self or child, or void. If set to void, then the target must expose, offer, or use the capability with OPTIONAL or TRANSITIONAL availability.

source_name: Option<String>

(Required) Name identifying the directory, by which it was presented to this component.

target: Option<Ref>

(Required) The destination to which the directory is exposed: either the component’s realm or the framework.

target_name: Option<String>

(Required) The name by which the capability is being exposed.

rights: Option<Operations>

(Optional) The maximum rights that can be set by a component using this directory. If unset, the rights are inherited from source.

subdir: Option<String>

(Optional) The subdirectory of this directory to expose instead of the root.

availability: Option<Availability>

(Optional, defaults to REQUIRED) The availability of this capability. See Availability.

source_dictionary: Option<String>

(Optional) Path in a dictionary offered by ref which contains source_name. If this field is absent, source_name identifies a capability directly routed by source. If set, source_name identifies a capability nested inside a dictionary. The name of the top-level dictionary is given by the first path segment of source_dictionary, and source is expected to route a dictionary capability with this name. The rest of the path (possibly empty) represents the path to a dictionary nested in the top-level dictionary which is expected to contain source_name.

Trait Implementations

impl Clone for ExposeDirectory

fn clone(&self) -> ExposeDirectory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExposeDirectory

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

Formats the value using the given formatter.

impl Decode<ExposeDirectory> for ExposeDirectory

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<'_>, offset: usize, depth: Depth ) -> Result<()>

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

impl Default for ExposeDirectory

fn default() -> ExposeDirectory

Returns the “default value” for a type.

impl Encode<ExposeDirectory> for &ExposeDirectory

unsafe fn encode( self, encoder: &mut Encoder<'_>, 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 ExposeDirectory

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

type Owned = ExposeDirectory

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 ExposeDirectory

type Borrowed<'a> = &'a ExposeDirectory

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<'a>(value: &'a <Self as TypeMarker>::Owned) -> Self::Borrowed<'a>

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

impl Persistable for ExposeDirectory

impl StructuralPartialEq for ExposeDirectory