Struct Options

pub struct Options<'a> {
    pub skip_journal_checks: bool,
    pub borrow_metadata_space: bool,
    pub allocator_reservation: Option<&'a Reservation>,
    pub txn_guard: Option<&'a TxnGuard<'a>>,
}

This allows for special handling of certain transactions such as deletes and the extension of Journal extents. For most other use cases it is appropriate to use default() here.

Fields

skip_journal_checks: bool

If true, don’t check for low journal space. This should be true for any transactions that might alleviate journal space (i.e. compaction).

borrow_metadata_space: bool

If true, borrow metadata space from the metadata reservation. This setting should be set to true for any transaction that will either not affect space usage after compaction (e.g. setting attributes), or reduce space usage (e.g. unlinking). Otherwise, a transaction might fail with an out-of-space error.

allocator_reservation: Option<&'a Reservation>

If specified, a reservation to be used with the transaction. If not set, any allocations that are part of this transaction will have to take their chances, and will fail if there is no free space. The intention is that this should be used for things like the journal which require guaranteed space.

txn_guard: Option<&'a TxnGuard<'a>>

An existing transaction guard to be used.

Trait Implementations

impl<'a> Clone for Options<'a>

fn clone(&self) -> Options<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for Options<'a>

fn default() -> Options<'a>

Returns the “default value” for a type.

impl<'a> Copy for Options<'a>