Struct Protocol

pub struct Protocol {
    pub name: Option<String>,
    pub as_: Option<String>,
    pub type_: Option<DependencyType>,
    pub path: Option<String>,
    pub availability: Option<Availability>,
    pub from_dictionary: Option<String>,
    /* private fields */
}

A protocol capability

Fields

name: Option<String>

The name of the capability. This is usually the name of the FIDL protocol, e.g. fuchsia.logger.LogSink. If path is not set, the protocol will be installed in a target component’s namespace at /svc/{name}.

as_: Option<String>

A rename of the capability, which can be set when routing to another component. This field is optional.

type_: Option<DependencyType>

For information on this type, see https://fuchsia.dev/go/components/declaration#DependencyType. This field is optional and defaults to STRONG.

path: Option<String>

Override the path in which the protocol is installed. Instead of /svc/{name}, this value will be used. Path should begin with a leading slash and omit a trailing slash, e.g. /foo/fuchsia.logger.LogSink. This field is optional.

availability: Option<Availability>

Optional. Cannot be set to SameAsTarget if to contains a local component.

from_dictionary: Option<String>

Optional. If set, the path to the dictionary routed by from which contains the capability.

Trait Implementations

impl Clone for Protocol

fn clone(&self) -> Protocol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Protocol

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

Formats the value using the given formatter.

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

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 Protocol

fn default() -> Protocol

Returns the “default value” for a type.

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

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 Protocol

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

type Owned = Protocol

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 Protocol

type Borrowed<'a> = &'a Protocol

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 Protocol

impl StructuralPartialEq for Protocol