Struct Opt 

pub struct Opt(/* private fields */);

One mi_option_t setting.

The associated constants name this fork’s own options plus the handful of upstream ones that interact with them; Opt::from_raw reaches any other enumerator in sys — it range-checks against _mi_option_last, because the C side indexes an array with this value and an out-of-range option would read out of bounds.

Implementations

impl Opt

pub const PROF: Self

Fork addition. Enable the sampled profiler at process start (MIMALLOC_PROF).

pub const PROF_SAMPLE_RATE: Self

Fork addition. Average byte interval between profiler samples.

pub const PROF_BT_MAX: Self

Fork addition. Maximum captured stack depth for the profiler.

pub const PROF_ACCUM: Self

Fork addition. Keep cumulative profiler counters until crate::prof::reset.

pub const PROF_SEED: Self

Fork addition. Profiler sampling PRNG seed; 0 = nondeterministic.

pub const PROF_MAX_BYTES: Self

Fork addition. Budget in bytes for profiler-internal arena memory.

pub const MEMORY_EVENTS: Self

Fork addition. Enable crate::memory_events accounting (MIMALLOC_MEMORY_EVENTS).

pub const PURGE_ZEROES: Self

Fork addition, dead since #80. Parses, but has no effect. Kept so nothing renumbers; unrelated to Opt::PURGE_HOLES_EAGER_ZERO.

pub const SCAVENGER: Self

Fork addition (Bun). Run the background scavenger thread.

pub const PURGE_HOLES: Self

Fork addition (Bun). Discard free blocks inside still-used pages on crate::on_thread_idle.

pub const PURGE_HOLES_EAGER_ZERO: Self

Fork addition (Bun). Zero a range before discarding it, so a mis-scoped discard corrupts visibly. Forced on in debug builds.

pub const PURGE_HOLES_MIN_INTERVAL: Self

Fork addition (Bun). Minimum milliseconds between sweeps of one thread’s heaps.

pub const PURGE_HOLES_FULL_EVERY: Self

Fork addition (Bun). Every N-th sweep walks every page; 0 disables.

pub const PURGE_DELAY: Self

Upstream: milliseconds to delay purging, which the scavenger also honours.

pub const SHOW_STATS: Self

Upstream: print statistics on process termination.

pub const SHOW_ERRORS: Self

Upstream: print error messages.

pub const VERBOSE: Self

Upstream: print verbose messages.

pub fn from_raw(raw: mi_option_t) -> Option<Self>

Wrap a raw mi_option_t from sys, or None if it is not a real option.

The range check is load bearing: the C implementation indexes its option table with this value, so an out-of-range option is an out-of-bounds read.

pub fn as_raw(self) -> mi_option_t

The raw mi_option_t value.

pub fn name(self) -> &'static str

The C enumerator’s name, e.g. mi_option_purge_holes.

Trait Implementations

impl Clone for Opt

fn clone(&self) -> Opt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Opt

impl Debug for Opt

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

Formats the value using the given formatter.

impl Eq for Opt

impl Hash for Opt

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 PartialEq for Opt

fn eq(&self, other: &Opt) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Opt