Struct fidl_fuchsia_driver_framework::DriverStartArgs

pub struct DriverStartArgs {
    pub node: Option<ClientEnd<NodeMarker>>,
    pub symbols: Option<Vec<NodeSymbol>>,
    pub url: Option<String>,
    pub program: Option<Dictionary>,
    pub incoming: Option<Vec<ComponentNamespaceEntry>>,
    pub outgoing_dir: Option<ServerEnd<DirectoryMarker>>,
    pub config: Option<Vmo>,
    pub node_name: Option<String>,
    /* private fields */
}

Arguments for starting a driver.

Fields

node: Option<ClientEnd<NodeMarker>>

Node that the driver is bound to.

symbols: Option<Vec<NodeSymbol>>

Symbols provided to the driver, for |node|. These come from the driver that added |node|, and are filtered to the symbols requested in the bind program.

url: Option<String>

URL of the package containing the driver. This is purely informational, used only to provide data for inspect.

program: Option<Dictionary>

Information about the driver to start. Currently, we support the following entries:

1. “binary”: a string containing the package-relative path to the driver binary.
2. “colocate” (optional): a string containing “true” or “false” specifying whether the driver should be colocated in the same driver host as the driver that added |node|. If not specified, the driver will be launched in a new driver host.
3. “default_dispatcher_opts” (optional): an array of strings specifying the options for creating the default dispatcher. A string can be one of the following:
   • allow_sync_calls: allows synchronous calls to be done on the default dispatcher’s thread.

incoming: Option<Vec<ComponentNamespaceEntry>>

Incoming namespace provided to the driver.

outgoing_dir: Option<ServerEnd<DirectoryMarker>>

Outgoing directory served by the driver.

config: Option<Vmo>

Configuration passed to the driver.

node_name: Option<String>

The name of the node the driver is bound to.

Implementations

impl DriverStartArgs

pub const EMPTY: Self = _

An empty table with every field set to None.

Trait Implementations

impl Debug for DriverStartArgs

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

Formats the value using the given formatter.

impl Decode<DriverStartArgs> for DriverStartArgs

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 Encode<DriverStartArgs> for &mut DriverStartArgs

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 Encode<DriverStartArgs> for DriverStartArgs

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<DriverStartArgs> for DriverStartArgs

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

type Borrowed<'a> = &'a mut DriverStartArgs

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

fn take_or_borrow<'a>( value: &'a mut <Self as TypeMarker>::Owned ) -> Self::Borrowed<'a>

Cheaply converts from &mut Self::Owned to Self::Borrowed. For HandleBased types this is “take” (it returns an owned handle and replaces value with Handle::invalid), and for all other types it is “borrow” (just converts from one reference to another).

impl TypeMarker for DriverStartArgs

type Owned = DriverStartArgs

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 StructuralPartialEq for DriverStartArgs

impl TopLevel for DriverStartArgs