Struct FxFilesystemBuilder

pub struct FxFilesystemBuilder { /* private fields */ }

Implementations

impl FxFilesystemBuilder

pub fn new() -> Self

pub fn format(self, format: bool) -> Self

Sets whether the block device should be formatted when opened. Defaults to false.

pub fn trace(self, trace: bool) -> Self

Enables or disables trace level logging. Defaults to false.

pub fn read_only(self, read_only: bool) -> Self

Sets whether the filesystem will be opened in read-only mode. Defaults to false. Incompatible with format.

pub fn image_builder_mode(self, enabled: bool) -> Self

For image building and in-place migration.

This mode avoids the initial write of super blocks and skips the journal for all transactions. The user must call finalize() before closing the filesystem to trigger a compaction of in-memory data structures, a minimal journal and a write to SuperBlock A.

pub fn roll_metadata_key_byte_count( self, roll_metadata_key_byte_count: u64, ) -> Self

Sets how often the metadata keys are rolled. See Options::roll_metadata_key_byte_count.

pub fn pre_commit_hook( self, hook: impl Fn(&Transaction<'_>) -> Result<(), Error> + Send + Sync + 'static, ) -> Self

Sets a callback that runs before every transaction. See Options::pre_commit_hook.

pub fn post_commit_hook( self, hook: impl Fn() -> BoxFuture<'static, ()> + Send + Sync + 'static, ) -> Self

Sets a callback that runs after every transaction has been committed. See Options::post_commit_hook.

pub fn skip_initial_reap(self, skip_initial_reap: bool) -> Self

Sets whether to do an initial reap of the graveyard at mount time. See Options::skip_initial_reap. Defaults to false.

pub fn journal_options(self, journal_options: JournalOptions) -> Self

Sets the options for the journal.

pub fn on_new_allocator( self, on_new_allocator: impl Fn(Arc<Allocator>) + Send + Sync + 'static, ) -> Self

Sets a method to be called immediately after creating the allocator.

pub fn on_new_store( self, on_new_store: impl Fn(&ObjectStore) + Send + Sync + 'static, ) -> Self

Sets a method to be called each time a new store is registered with ObjectManager.

pub fn fsck_after_every_transaction( self, fsck_after_every_transaction: bool, ) -> Self

Enables or disables running fsck after every transaction. Defaults to false.

pub fn trim_config( self, delay_and_interval: Option<(Duration, Duration)>, ) -> Self

pub async fn open(self, device: DeviceHolder) -> Result<OpenFxFilesystem, Error>

Constructs an FxFilesystem object with the specified settings.