Struct StartOptions

pub struct StartOptions {
    pub read_only: bool,
    pub verbose: bool,
    pub fsck_after_every_transaction: bool,
    pub write_compression_algorithm: CompressionAlgorithm,
    pub write_compression_level: i32,
    pub cache_eviction_policy_override: EvictionPolicyOverride,
    pub startup_profiling_seconds: u32,
    pub inline_crypto_enabled: bool,
    pub barriers_enabled: bool,
}

Options for starting a filesystem.

Fields

read_only: bool

Start the filesystem in read-only mode.

verbose: bool

Enable verbose logging.

fsck_after_every_transaction: bool

If true, run fsck after every transaction. This is for testing purposes only - it’s very slow to run a filesystem like this.

write_compression_algorithm: CompressionAlgorithm

A compression algorithm specifier for the filesystem to use when storing files (if the filesystem supports it). Defaults to ZSTD_CHUNKED.

write_compression_level: i32

An optional compression level for the filesystem to use when storing files (if the filesystem and the configured |write_compression_algorithm| supports it). Setting to < 0 indicates no value (the filesystem chooses a default if necessary).

cache_eviction_policy_override: EvictionPolicyOverride

An optional eviction policy specifier for the filesystem to use for in-memory structures (if the filesystem supports it), specifically for pager-backed files.

startup_profiling_seconds: u32

Set greater than zero to use profiling for the first N seconds after filesystem start. Records the access patterns of objects for N seconds and if the profile already exists, prefetch data and hold the vmos in cache for N seconds. Functionally this means that the first launch with this option records the profile and all other launches with this option will replay that profile.

inline_crypto_enabled: bool

If true, configures the filesystem to use the hardware’s inline encryption engine when writing encrypted data. This allows the filesystem to store user-encrypted data without being able to read or write the plaintext contents, which enhances security and privacy. Requires the block device to support inline encryption and for barriers_enabled to be true. TODO(https://fxbug.dev/393196849): For now, this flag only prevents the filesystem from computing checksums. Update this comment when the filesystem actually uses inline encryption.

barriers_enabled: bool

Configures the filesystem to use barriers instead of checksums to ensure consistency. If set, barriers will be used to enforce proper ordering of data and metadata writes, which is otherwise provided by computing and verifying data checksums. Requires filesystem support; at the time of writing, only Fxfs uses this argument. Must be set to true if inline_crypto_enabled is true.

Trait Implementations

impl Debug for StartOptions

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

Formats the value using the given formatter.

impl Decode<StartOptions, DefaultFuchsiaResourceDialect> for StartOptions

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 Encode<StartOptions, DefaultFuchsiaResourceDialect> for &mut StartOptions

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<T0: Encode<bool, DefaultFuchsiaResourceDialect>, T1: Encode<bool, DefaultFuchsiaResourceDialect>, T2: Encode<bool, DefaultFuchsiaResourceDialect>, T3: Encode<CompressionAlgorithm, DefaultFuchsiaResourceDialect>, T4: Encode<i32, DefaultFuchsiaResourceDialect>, T5: Encode<EvictionPolicyOverride, DefaultFuchsiaResourceDialect>, T6: Encode<u32, DefaultFuchsiaResourceDialect>, T7: Encode<bool, DefaultFuchsiaResourceDialect>, T8: Encode<bool, DefaultFuchsiaResourceDialect>> Encode<StartOptions, DefaultFuchsiaResourceDialect> for (T0, T1, T2, T3, T4, T5, T6, T7, T8)

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

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 StartOptions

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

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

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

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

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 StartOptions

type Owned = StartOptions

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 Eq for StartOptions

impl Standalone<DefaultFuchsiaResourceDialect> for StartOptions

impl StructuralPartialEq for StartOptions