Struct MlockConfigBuilder 

pub struct MlockConfigBuilder { /* private fields */ }

Builder for MlockConfig.

Example

use duende_mlock::MlockConfig;

let config = MlockConfig::builder()
    .current(true)
    .future(true)
    .required(false)
    .build();

Implementations

impl MlockConfigBuilder

pub const fn new() -> Self

Create a new builder with default values.

pub const fn current(self, value: bool) -> Self

Lock pages currently mapped (MCL_CURRENT).

Default: true

pub const fn future(self, value: bool) -> Self

Lock pages mapped in the future (MCL_FUTURE).

Default: true

pub const fn required(self, value: bool) -> Self

Whether mlock failure should return an error.

• true (default): Return Err(MlockError) on failure
• false: Return Ok(MlockStatus::Failed { .. }) on failure

Use false when mlock is optional and the daemon should continue with degraded safety guarantees.

pub const fn onfault(self, value: bool) -> Self

Use on-fault locking (MCL_ONFAULT, Linux 4.4+).

When enabled, pages are locked only when they are first accessed (faulted in), rather than immediately. This reduces initial memory pressure for daemons with large potential address spaces.

Default: false

Ignored on platforms that don’t support it.

pub const fn build(self) -> MlockConfig

Build the configuration.

Trait Implementations

impl Clone for MlockConfigBuilder

fn clone(&self) -> MlockConfigBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MlockConfigBuilder

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

Formats the value using the given formatter.

impl Default for MlockConfigBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Copy for MlockConfigBuilder