Struct HarnessConfig

pub struct HarnessConfig {
    pub supports_executable_file: bool,
    pub supports_mutable_file: bool,
    pub supports_get_backing_memory: bool,
    pub supports_remote_dir: bool,
    pub supports_get_token: bool,
    pub supports_link_into: bool,
    pub supports_append: bool,
    pub supports_truncate: bool,
    pub supported_attributes: NodeAttributesQuery,
    pub supports_modify_directory: bool,
    pub supports_services: bool,
}

Conformance test harnesses will implement this protocol to setup its associated filesystem servers with the described directory layout, allowing their implementation of fuchsia.io and fuchsia.io2 protocols to be verified by a common test suite.

Different test cases will not interact with one another during the conformance test, and only one test case will be active at a time per tested filesystem. So it is possible to host all cases as different sub-directories under a common filesystem instance, to simplify the lifecycle and implementation.

If a test case has mutable bits, each method call should be implemented to obtain the directory in its original state. In other words, repeated test case set up should “as-if” yield new directories.

See src/storage/conformance/README.md for an overview of io conformance testing.

HarnessConfig lets the test harness modulate the set of expected outcomes and behaviors validated by the test suite, by declaring specific properties about the filesystem implementation. For example, setting [ImmutableFile] to true informs the test suites that files hosted by this harness do not support mutation.

Fields

supports_executable_file: bool

ExecutableFile objects are supported.

supports_mutable_file: bool

Supports writing to files and updating file attributes.

supports_get_backing_memory: bool

GetBackingMemory is supported.

supports_remote_dir: bool

Remote directories are supported.

supports_get_token: bool

GetToken is supported.

supports_link_into: bool

Supports fuchsia.io’s LinkInto method.

supports_append: bool

Files can be opened in append mode.

supports_truncate: bool

Files can be truncated (resized).

supported_attributes: NodeAttributesQuery

The set of attributes the filesystem supports. If mutable attributes are reported, the harness must support [fuchsia.io/Node.SetAttr] and [fuchsia.io/Node.UpdateAttributes].

supports_modify_directory: bool

Directories support creating files, Rename, Link, and Unlink.

supports_services: bool

Supports services.

Trait Implementations

impl Clone for HarnessConfig

fn clone(&self) -> HarnessConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HarnessConfig

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

Formats the value using the given formatter.

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

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<D: ResourceDialect> Encode<HarnessConfig, D> for &HarnessConfig

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<D: ResourceDialect, T0: Encode<bool, D>, T1: Encode<bool, D>, T2: Encode<bool, D>, T3: Encode<bool, D>, T4: Encode<bool, D>, T5: Encode<bool, D>, T6: Encode<bool, D>, T7: Encode<bool, D>, T8: Encode<NodeAttributesQuery, D>, T9: Encode<bool, D>, T10: Encode<bool, D>> Encode<HarnessConfig, D> for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

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 Hash for HarnessConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for HarnessConfig

fn cmp(&self, other: &HarnessConfig) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for HarnessConfig

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

fn partial_cmp(&self, other: &HarnessConfig) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TypeMarker for HarnessConfig

type Owned = HarnessConfig

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 HarnessConfig

type Borrowed<'a> = &'a HarnessConfig

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 Copy for HarnessConfig

impl Eq for HarnessConfig

impl Persistable for HarnessConfig

impl StructuralPartialEq for HarnessConfig