Skip to main content

ProfConfig

Struct ProfConfig 

Source
#[non_exhaustive]
pub struct ProfConfig { pub mode: ProfConfigMode, pub sample_interval: Option<usize>, pub max_profiler_bytes: Option<usize>, pub seed: Option<u64>, pub accum: bool, pub max_stack_depth: Option<usize>, pub dump_at_exit: Option<PathBuf>, pub dump_format: DumpFormat, }
Expand description

Ergonomic, Rust-facing sibling of mi_prof_config_t (include/mimalloc/profile.h) for enable_heap_profiling_with.

Fields mirror the C struct one-for-one, but trade its 0/NULL-means-unset raw-integer conventions for Option<T> and enums where that reads better. #[non_exhaustive] + Default keeps future fields additive: build from Default::default() and set the fields you need, e.g.

use mimalloc_pprof::ProfConfig;
let mut config = ProfConfig::default();
config.sample_interval = Some(4096);

(Within this crate, struct-update syntax like ProfConfig { sample_interval: Some(4096), ..Default::default() } also works; #[non_exhaustive] only blocks struct-literal construction from other crates, so new fields stay non-breaking for them.)

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§mode: ProfConfigMode§sample_interval: Option<usize>

Average bytes between samples. None = env/default (512 KiB).

§max_profiler_bytes: Option<usize>

Budget (bytes) for profiler-internal persistent sampling state (sample records, the stack intern table, interned stack entries). None = unbudgeted (cap-bounded only).

§seed: Option<u64>

None = nondeterministic.

§accum: bool§max_stack_depth: Option<usize>

None = default (32); compile cap 128.

§dump_at_exit: Option<PathBuf>

Path to dump the profile to at process exit. None = no exit dump.

§dump_format: DumpFormat

Format used for the exit dump. Ignored if dump_at_exit is None.

Trait Implementations§

Source§

impl Clone for ProfConfig

Source§

fn clone(&self) -> ProfConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProfConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ProfConfig

Source§

fn default() -> ProfConfig

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.