Struct Error

Source

pub struct Error { /* private fields */ }

Expand description

A list specifying general categories of map errors.

These errors can be converted into std::io::Error values.

§Examples

fn create_map() -> vmap::Result<vmap::Map> {
    /// ...
}

fn main() -> std::io::Result<()> {
    let map = create_map()?;
    println!("len = {}\n", map.len());
    Ok(())
}

Implementations§

Source §

impl Error

Source

pub fn io(op: Operation, err: Error) -> Self

Returns an error that wraps a std::io::Error along with an Operation.

§Examples

use std::io::ErrorKind;
use vmap::{Error, Operation};

println!("I/O error: {:?}", Error::io(
    Operation::MapFile,
    ErrorKind::NotFound.into(),
));

Source

pub fn input(op: Operation, input: Input) -> Self

Returns an error that wraps an Input type along with an Operation.

§Examples

use vmap::{Error, Operation, Input};

println!("Input error: {:?}", Error::input(
    Operation::MapFile,
    Input::InvalidRange,
));

Source

pub fn system(op: Operation, err: Error) -> Self

Returns an error that wraps a system_error::Error along with an Operation.

§Examples

use std::io::ErrorKind;
use vmap::{Error, Operation};

println!("System error: {:?}", Error::system(
    Operation::MapFile,
    system_error::Error::last_os_error()
));

Source

pub fn kernel(op: Operation, code: KernelCode) -> Self

Returns an error that wraps a system_error::KernelCode along with an Operation.

§Examples

use vmap::{Error, Operation};

println!("Kernel error: {:?}", Error::kernel(
    Operation::RingAllocate,
    1,
));

Source

pub fn last_os_error(op: Operation) -> Self

Returns an error representing the last OS error which occurred.

This function reads the value of errno for the target platform (e.g. GetLastError on Windows) and will return a corresponding instance of Error for the error code.

§Examples

use vmap::{Error, Operation};

println!("last OS error: {:?}", Error::last_os_error(Operation::MapFile));

Source

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

Returns the OS error that this error represents (if any).

If this Error was constructed via last_os_error, then this function will return Some, otherwise it will return None.

§Examples

use vmap::{Error, Input, Operation};

fn print_os_error(err: &Error) {
    if let Some(raw_os_err) = err.raw_os_error() {
        println!("raw OS error: {:?}", raw_os_err);
    } else {
        println!("Not an OS error");
    }
}

// Will print "raw OS error: ...".
print_os_error(&Error::last_os_error(Operation::MapFile));
// Will print "Not an OS error".
print_os_error(&Error::input(Operation::MapFile, Input::InvalidRange));

Source

pub fn kind(&self) -> ErrorKind

Returns the corresponding std::io::ErrorKind for this error.

§Examples

use std::io::ErrorKind;
use vmap::{Error, Operation};

fn print_error(err: Error) {
    println!("{:?}", err.kind());
}

// Will print "Other".
print_error(Error::last_os_error(Operation::MapFile));
// Will print "NotFound".
print_error(Error::io(Operation::MapFile, ErrorKind::NotFound.into()));

Source

pub fn operation(&self) -> Operation

Returns the corresponding Operation that cuased the error.

§Examples

use vmap::{Error, Operation};

fn print_operation(err: Error) {
    println!("{:?}", err.operation());
}

// Will print "MapFile".
print_operation(Error::last_os_error(Operation::MapFile));