Struct LockError 

pub struct LockError { /* private fields */ }

Available on crate feature sealed only.

Why the pre-key’s pages are not locked in RAM. Returned by Prekey::lock_status.

Not fatal: the sealed types work the same either way. What is lost is the guarantee that the pre-key never reaches the swap file. On Windows the usual cause is the process working-set quota, which every VirtualLock in the process shares; on Unix it is RLIMIT_MEMLOCK.

It is also returned, without asking the operating system, for a pre-key made with Prekey::new_idle_noaccess on Windows, where a no-access page cannot stay locked, and in a fork() child of the process that made the pre-key, which does not inherit its lock.

Carries the operating system’s error code, never an address.

Example

Report the reason, and raise the quota where it is the cause:

use secure_gate::Prekey;

let prekey = Prekey::new();
match prekey.lock_status() {
    Ok(()) => {}
    // ERROR_WORKING_SET_QUOTA: every `VirtualLock` in a Windows process shares the
    // working-set quota (about eleven pre-keys under the default). Raise it at startup
    // with `SetProcessWorkingSetSize` if the application holds more.
    Err(why) if why.raw_os_error() == Some(1453) => eprintln!("raise the quota: {why}"),
    Err(why) => eprintln!("sealed secrets work, but may reach swap: {why}"),
}

Implementations

impl LockError

pub fn raw_os_error(&self) -> Option<i32>

The operating system’s error code (GetLastError on Windows, errno on Unix), when the lock was attempted and refused.

pub fn idle_noaccess(&self) -> bool

true when locking was not attempted because the pre-key was made with Prekey::new_idle_noaccess on Windows: a no-access page leaves the process’s working set, and its lock with it.

pub fn forked(&self) -> bool

true in a fork() child of the process that made the pre-key: page locks are not inherited, so the child holds the pre-key unlocked whatever the parent was granted.

Trait Implementations

impl Clone for LockError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LockError

impl Debug for LockError

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

Formats the value using the given formatter.

impl Display for LockError

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

Formats the value using the given formatter.

impl Eq for LockError

impl Error for LockError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for LockError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LockError