mmap-rs 0.6.1

A cross-platform and safe Rust API to create and manage memory mappings in the virtual address space of the calling process.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

//! This module implements the error type used throughout this crate.

use crate::UnsafeMmapFlags;
use thiserror::Error;

/// The error type.
#[derive(Debug, Error)]
pub enum Error {
    /// The following set of unsafe flags must be set to call this function.
    #[error("{0:?} must be set")]
    UnsafeFlagNeeded(UnsafeMmapFlags),

    /// The size is invalid.
    #[error("invalid size")]
    InvalidSize,

    /// The offset is invalid.
    #[error("invalid offset")]
    InvalidOffset,

    /// The operation is invalid.
    #[error("invalid operation")]
    InvalidOperation,

    /// The memory maps must be adjacent.
    #[error("the memory maps must be adjacent")]
    MustBeAdjacent,

    /// The attributes of the memory maps do not match.
    #[error("the memory maps must share the same attributes")]
    AttributeMismatch,

    /// The backings of the memory maps do not match.
    #[error("the memory maps must share the same backing")]
    BackingMismatch,

    /// Represents [`std::io::Error`].
    #[error(transparent)]
    Io(#[from] std::io::Error),

    /// Represents [`std::num::ParseIntError`].
    #[error(transparent)]
    ParseInt(#[from] std::num::ParseIntError),

    /// Represents [`std::str::Utf8Error`].
    #[error(transparent)]
    Utf8(std::str::Utf8Error),

    #[cfg(unix)]
    /// Represents [`nix::Error`].
    #[error(transparent)]
    Nix(#[from] nix::Error),

    #[cfg(unix)]
    /// Represents [`sysctl::SysctlError`].
    #[error(transparent)]
    Sysctl(#[from] sysctl::SysctlError),

    #[cfg(any(target_os = "macos", target_os = "ios"))]
    /// The error code returned from the Mach API.
    #[error("Mach kernel result = {0}")]
    Mach(libc::c_int),

    #[cfg(target_os = "windows")]
    /// Represents [`windows::core::Error`].
    #[error(transparent)]
    Windows(#[from] windows::core::Error),
}