Enum vmap::Operation

#[non_exhaustive]
pub enum Operation {
    MapFile,
    MapFileHandle,
    MapFileView,
    MapAnonymous,
    MapAnonymousHandle,
    MapAnonymousView,
    Unmap,
    Protect,
    Advise,
    Lock,
    Unlock,
    Flush,
    RingAllocate,
    RingDeallocate,
    RingEntry,
    RingPrimary,
    RingSecondary,
    MemoryFd,
    None,
}

A list specifying general categories of erroneous operations.

This list is intended to grow over time and it is not recommended to exhaustively match against it.

It is used with the Error type.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MapFile

The operation failed while attempting to map a file.

MapFileHandle

A map file handle failed to open.

MapFileView

The view for a map file handle could not be created.

MapAnonymous

The operation failed while attempting to allocate an anonymous mapping.

MapAnonymousHandle

An anonymous mapping handle failed to open.

MapAnonymousView

The view for an anonymouse mapping handle could not be created.

Unmap

A pointer could not be unmapped.

Protect

The Protect could not be applied to the provided memory region.

Advise

The AdviseAccess or AdviseUsage could not be applied to the provided memory region.

Lock

The physical page could not be locked into memory.

Unlock

The physical page could not be unlocked from memory.

Flush

A flush cannot be perfomed for the provided input.

RingAllocate

The full address space for a ring could not be allocated.

RingDeallocate

The full address space for a ring could not be deallocated.

RingEntry

A virtual mapping entry could not be created.

RingPrimary

The mapping for the first half of the ring failed to allocate.

RingSecondary

The mapping for the second half of the ring failed to allocate.

MemoryFd

A temporary memory file descriptor failed to open.

None

Used for pure I/O errors to simplify wrapping a std::io::Error into an

Implementations

impl Operation

pub fn as_str(&self) -> Option<&'static str>

Returns a display message fragment describing the Operation type.

The result of as_str is used to Display the Operation.

Examples

use vmap::Operation;

fn print_operation(op: Operation) {
    println!("failed to {}", op.as_str().unwrap());
}

// Will print "failed to map file".
print_operation(Operation::MapFile);

Trait Implementations

impl Clone for Operation

fn clone(&self) -> Operation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Operation

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

Formats the value using the given formatter.

impl Display for Operation

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

Formats the value using the given formatter.

impl Hash for Operation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Operation

fn cmp(&self, other: &Operation) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Operation> for Operation

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Operation> for Operation

fn partial_cmp(&self, other: &Operation) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Operation

impl Eq for Operation

impl StructuralEq for Operation

impl StructuralPartialEq for Operation