Struct fidl_fuchsia_component_decl::OfferService

pub struct OfferService {
    pub source: Option<Ref>,
    pub source_name: Option<String>,
    pub target: Option<Ref>,
    pub target_name: Option<String>,
    pub source_instance_filter: Option<Vec<String>>,
    pub renamed_instances: Option<Vec<NameMapping>>,
    pub availability: Option<Availability>,
    pub source_dictionary: Option<String>,
    pub dependency_type: Option<DependencyType>,
    /* private fields */
}

Declares a service offered by a component to one of its children, which may have been offered by the component’s containing realm, the component itself, or one of its other children.

To learn more about services, see: https://fuchsia.dev/fuchsia-src/glossary#service

Fields

source: Option<Ref>

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

source_name: Option<String>

(Required) Name identifying the service being offered.

target: Option<Ref>

(Required) Reference to the target. Must be child, collection, or a dictionary capability.

target_name: Option<String>

(Required) The name under which the capability is being offered.

source_instance_filter: Option<Vec<String>>

(Optional) The list of allowlisted instances to be offered. Instances of the service not in this list will not be accessible by the target component. If this is not set that means all instances from the source service are offered.

renamed_instances: Option<Vec<NameMapping>>

(Optional) The list of allowlisted instances to be offered, with renames.

If this is set and nonempty, the set of instances in the target service will be restricted to the instances in this list, renaming source_name to target_name.

If it is set and nonempty, source_instance_filter will further restrict the set of instances to those whose target_name appears in that list. There is generally no reason to set both, but we support it for compatibility.

availability: Option<Availability>

(Optional, defaults to REQUIRED) The availability of this capability. If set to required, the target may use or offer the capability with either required or optional availability. If set to optional, the target must use or offer the capability with optional availability. The same_as_target value causes this offer’s availability to match the availability set in the target.

source_dictionary: Option<String>

(Optional) Path in a dictionary provided by source 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 this dictionary.

dependency_type: Option<DependencyType>

(Optional, defaults to STRONG) The dependency type this offer represents. A component which receives a weak offer must support the offered capability being unavailable at any point.

Trait Implementations

impl Clone for OfferService

fn clone(&self) -> OfferService

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OfferService

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

Formats the value using the given formatter.

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

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 OfferService

fn default() -> OfferService

Returns the “default value” for a type.

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

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 OfferService

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

type Owned = OfferService

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 OfferService

type Borrowed<'a> = &'a OfferService

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 OfferService

impl StructuralPartialEq for OfferService