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, when the page size is larger than the pre-key’s block is aligned for (16 KiB on x86, x86_64 and Apple aarch64; 64 KiB elsewhere): the pre-key would then share a page with other memory, and unlocking it on drop would unlock that memory too.

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

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 failure came from a system call.

pub fn page_too_large(&self) -> Option<usize>

The page size, when locking was not attempted because a page is larger than the pre-key’s block is aligned for (16 KiB on x86, x86_64 and Apple aarch64; 64 KiB elsewhere). A page larger than the 16 KiB pre-key but within that alignment is locked, not reported.

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