Enum Policy 

pub enum Policy {
    BestEffort,
    Strict,
    Disabled,
}

Policy controlling how memory protection failures are handled.

Variants

BestEffort

Best effort: attempt protection, fall back gracefully on failure.

This is the recommended default for most applications. Memory will be protected when possible, but the application will continue to function even if mlock or guard pages are unavailable (e.g., due to resource limits or platform restrictions).

Strict

Strict: require all protection features to succeed.

Operations will return an error if memory cannot be locked or guard pages cannot be created. Use this in high-security contexts where degraded protection is unacceptable.

Disabled

Disabled: skip all platform-specific protection.

Memory is still zeroized on drop, but mlock, guard pages, and MADV_DONTDUMP are not used. This is useful for testing or when running in restricted environments like WASM.

Implementations

impl Policy

pub fn is_strict(self) -> bool

Returns true if protection failures should be treated as errors.

pub fn protection_enabled(self) -> bool

Returns true if memory protection should be attempted.

Trait Implementations

impl Clone for Policy

fn clone(&self) -> Policy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Policy

impl Debug for Policy

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

Formats the value using the given formatter.

impl Default for Policy

fn default() -> Policy

Returns the “default value” for a type.

impl Eq for Policy

impl PartialEq for Policy

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