Enum MlockStatus 

pub enum MlockStatus {
    Locked {
        bytes_locked: usize,
    },
    Failed {
        errno: i32,
    },
    Unsupported,
}

Result of a memory locking operation.

This type captures both successful and unsuccessful (but non-fatal) outcomes. Fatal errors are returned as Err(MlockError).

Variants

Locked

Memory was successfully locked.

Contains the number of bytes locked at the time of the call. Note: This may increase as more memory is allocated (with MCL_FUTURE).

Fields

bytes_locked: usize

Bytes locked at time of call (from /proc/self/status VmLck).

Failed

Memory locking failed but was not required.

Only returned when MlockConfig::required(false) is set. The daemon should continue with a warning.

Fields

errno: i32

The errno that caused the failure.

Unsupported

Memory locking is not supported on this platform.

Returned on non-Unix platforms (Windows, WASM, etc.).

Implementations

impl MlockStatus

pub const fn is_locked(&self) -> bool

Check if memory is currently locked.

Returns true for MlockStatus::Locked, false otherwise.

pub const fn is_failed(&self) -> bool

Check if locking failed.

Returns true for MlockStatus::Failed, false otherwise.

pub const fn is_unsupported(&self) -> bool

Check if mlock is unsupported on this platform.

Returns true for MlockStatus::Unsupported, false otherwise.

pub const fn bytes_locked(&self) -> usize

Get the number of bytes locked.

Returns the bytes locked for MlockStatus::Locked, 0 otherwise.

pub const fn failure_errno(&self) -> Option<i32>

Get the failure errno, if any.

Returns Some(errno) for MlockStatus::Failed, None otherwise.

Trait Implementations

impl Clone for MlockStatus

fn clone(&self) -> MlockStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MlockStatus

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

Formats the value using the given formatter.

impl Display for MlockStatus

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

Formats the value using the given formatter.

impl PartialEq for MlockStatus

fn eq(&self, other: &MlockStatus) -> 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 MlockStatus

impl Eq for MlockStatus

impl StructuralPartialEq for MlockStatus