Struct MlockConfig 

pub struct MlockConfig { /* private fields */ }

Configuration for memory locking operations.

Use MlockConfig::builder() for a fluent configuration API:

use duende_mlock::MlockConfig;

let config = MlockConfig::builder()
    .current(true)      // Lock pages currently mapped
    .future(true)       // Lock pages mapped in the future
    .required(false)    // Don't fail if mlock fails
    .build();

Implementations

impl MlockConfig

pub const fn builder() -> MlockConfigBuilder

Create a new configuration builder.

Example

use duende_mlock::MlockConfig;

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

pub const fn current(&self) -> bool

Whether to lock currently mapped pages.

pub const fn future(&self) -> bool

Whether to lock future page mappings.

pub const fn required(&self) -> bool

Whether mlock failure is fatal.

pub const fn onfault(&self) -> bool

Whether to use on-fault locking (Linux 4.4+).

Trait Implementations

impl Clone for MlockConfig

fn clone(&self) -> MlockConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MlockConfig

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

Formats the value using the given formatter.

impl Default for MlockConfig

fn default() -> Self

Default configuration: lock current and future pages, required mode.

Equivalent to:

use duende_mlock::MlockConfig;

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

impl PartialEq for MlockConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for MlockConfig

impl Eq for MlockConfig

impl StructuralPartialEq for MlockConfig