Struct RealmArgs

pub struct RealmArgs {

    pub boot: Option<ClientEnd<DirectoryMarker>>,
    pub root_driver: Option<String>,
    pub use_driver_framework_v2: Option<bool>,
    pub driver_tests_enable_all: Option<bool>,
    pub driver_tests_enable: Option<Vec<String>>,
    pub driver_tests_disable: Option<Vec<String>>,
    pub driver_log_level: Option<Vec<DriverLog>>,
    pub driver_disable: Option<Vec<String>>,
    pub driver_bind_eager: Option<Vec<String>>,
    pub board_name: Option<String>,
    pub offers: Option<Vec<Offer>>,
    pub exposes: Option<Vec<Expose>>,
    pub pkg: Option<ClientEnd<DirectoryMarker>>,
    pub dtr_offers: Option<Vec<Capability>>,
    pub dtr_exposes: Option<Vec<Capability>>,
    pub test_component: Option<Component>,
    pub driver_index_stop_timeout_millis: Option<i64>,
    pub software_devices: Option<Vec<SoftwareDevice>>,
    pub boot_driver_components: Option<Vec<String>>,
    /* private fields */
}

A list of arguments that can be used to configure DriverTestRealm.

Fields

boot: Option<ClientEnd<DirectoryMarker>>

This is what DriverManager will see as its boot directory. Default: DriverTestRealm’s package directory

root_driver: Option<String>

The URL for the driver that will be bound to root. Default: fuchsia-boot:///dtr#meta/test-parent-sys.cm NOTE: The test parent driver is not included by default. This must be included in your package to work correctly.

use_driver_framework_v2: Option<bool>

If this is true, then DriverManager will load DFv2 drivers. Default: false

driver_tests_enable_all: Option<bool>

If this is true, then DriverManager will enable the unit tests for each driver that is loaded. Default: false

driver_tests_enable: Option<Vec<String>>

If this is true, then DriverManager will enable the unit tests for each driver in this vector. Default: empty

driver_tests_disable: Option<Vec<String>>

If this is true, then DriverManager will disable the unit tests for each driver in this vector. This overrides both a specific request for enabling a test and the ‘driver_tests_enable_all’ parameter. Default: empty

driver_log_level: Option<Vec<DriverLog>>

Set a log level for the specific driver. Default: Log levels are set to INFO

driver_disable: Option<Vec<String>>

Disable specific drivers. These drivers will not be bound or loaded. Default: empty

driver_bind_eager: Option<Vec<String>>

Specify drivers to bind ‘eagerly’. This turns a driver that normally binds as a fallback driver into a driver that will be bound normally. Default: empty

board_name: Option<String>

Specify the board name that drivers are aware of. Default: driver-integration-test

offers: Option<Vec<Offer>>

DEPRECATED: Use dtr_offers. Specify additional offers from the test to a driver collection Default: empty

exposes: Option<Vec<Expose>>

DEPRECATED: Use dtr_exposes. Specify services to expose from the test to a driver collection Default: empty

pkg: Option<ClientEnd<DirectoryMarker>>

DEPRECATED: Use test_component to provide resolved test component. The driver test realm can load drivers packaged with the test suite through this directory. Note that this directory must be readable and executable.

This can be used if the test suite needs to use some drivers packaged with the DriverTestRealm in addition to drivers packaged with the test suite. In that case, the user can leave RealmArgs::boot unset and use RealmArgs::pkg and RealmArgs::driver_urls.

Drivers in this directory can be registered using the driver_urls argument below.

Default: DriverTestRealm’s package directory.

dtr_offers: Option<Vec<Capability>>

Specify offers from the test to the driver test realm. The driver test realm will forward these to the driver collections. Default: empty

dtr_exposes: Option<Vec<Capability>>

Specify exposes from the driver test realm to the test. The driver test realm will forward these from the driver collections. Default: empty

test_component: Option<Component>

The resolved component information of the test component that is starting the driver test realm. This will be used to discover drivers that the test wants to provide to the driver test realm. Drivers can be both in the test component package, or a subpackage of the test component package. By default all drivers discovered that don’t also exist in the |boot| directory will be considered to be base drivers. Use |boot_driver_components| to provide a list of drivers that should be boot drivers. Default: empty

driver_index_stop_timeout_millis: Option<i64>

How long the driver index waits idle before it saves state, escrows its handles with the component framework, and shuts down. Default: never shuts down

software_devices: Option<Vec<SoftwareDevice>>

A list of software only devices that should be created. Typically this is used to create fake hardware for tests. Devices will be spawned as platform devices under the platform bus. Note that the platform bus must be the root driver for this to do anything meaningful.

boot_driver_components: Option<Vec<String>>

The list of driver component names that should be considered as boot drivers. Boot drivers are started in the boot-drivers collection which has more capabilities available to it. Entries should be the component name (eg: “my_driver_component.cm”). Default: empty

Trait Implementations

impl Debug for RealmArgs

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

Formats the value using the given formatter.

impl Decode<RealmArgs, DefaultFuchsiaResourceDialect> for RealmArgs

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

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

impl Default for RealmArgs

fn default() -> RealmArgs

Returns the “default value” for a type.

impl Encode<RealmArgs, DefaultFuchsiaResourceDialect> for &mut RealmArgs

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

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

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

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 RealmArgs

type Owned = RealmArgs

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 Standalone<DefaultFuchsiaResourceDialect> for RealmArgs

impl StructuralPartialEq for RealmArgs