Struct nix::sys::mman::MapFlags

pub struct MapFlags(/* private fields */);

Additional parameters for mmap.

Implementations

impl MapFlags

pub const MAP_FILE: Self = _

Compatibility flag. Ignored.

pub const MAP_SHARED: Self = _

Share this mapping. Mutually exclusive with MAP_PRIVATE.

pub const MAP_SHARED_VALIDATE: Self = _

Force mmap to check and fail on unknown flags. This also enables MAP_SYNC.

pub const MAP_PRIVATE: Self = _

Create a private copy-on-write mapping. Mutually exclusive with MAP_SHARED.

pub const MAP_FIXED: Self = _

Place the mapping at exactly the address specified in addr.

pub const MAP_FIXED_NOREPLACE: Self = _

Place the mapping at exactly the address specified in addr, but never clobber an existing range.

pub const MAP_ANON: Self = _

Synonym for MAP_ANONYMOUS.

pub const MAP_ANONYMOUS: Self = _

The mapping is not backed by any file.

pub const MAP_32BIT: Self = _

Put the mapping into the first 2GB of the process address space.

pub const MAP_GROWSDOWN: Self = _

Used for stacks; indicates to the kernel that the mapping should extend downward in memory.

pub const MAP_DENYWRITE: Self = _

Compatibility flag. Ignored.

pub const MAP_EXECUTABLE: Self = _

Compatibility flag. Ignored.

pub const MAP_LOCKED: Self = _

Mark the mmaped region to be locked in the same way as mlock(2).

pub const MAP_NORESERVE: Self = _

Do not reserve swap space for this mapping.

This was removed in FreeBSD 11 and is unused in DragonFlyBSD.

pub const MAP_POPULATE: Self = _

Populate page tables for a mapping.

pub const MAP_NONBLOCK: Self = _

Only meaningful when used with MAP_POPULATE. Don’t perform read-ahead.

pub const MAP_HUGETLB: Self = _

Allocate the mapping using “huge pages.”

pub const MAP_HUGE_64KB: Self = _

Make use of 64KB huge page (must be supported by the system)

pub const MAP_HUGE_512KB: Self = _

Make use of 512KB huge page (must be supported by the system)

pub const MAP_HUGE_1MB: Self = _

Make use of 1MB huge page (must be supported by the system)

pub const MAP_HUGE_2MB: Self = _

Make use of 2MB huge page (must be supported by the system)

pub const MAP_HUGE_8MB: Self = _

Make use of 8MB huge page (must be supported by the system)

pub const MAP_HUGE_16MB: Self = _

Make use of 16MB huge page (must be supported by the system)

pub const MAP_HUGE_32MB: Self = _

Make use of 32MB huge page (must be supported by the system)

pub const MAP_HUGE_256MB: Self = _

Make use of 256MB huge page (must be supported by the system)

pub const MAP_HUGE_512MB: Self = _

Make use of 512MB huge page (must be supported by the system)

pub const MAP_HUGE_1GB: Self = _

Make use of 1GB huge page (must be supported by the system)

pub const MAP_HUGE_2GB: Self = _

Make use of 2GB huge page (must be supported by the system)

pub const MAP_HUGE_16GB: Self = _

Make use of 16GB huge page (must be supported by the system)

pub const MAP_STACK: Self = _

Region grows down, like a stack.

pub const MAP_SYNC: Self = _

Do not write through the page caches, write directly to the file. Used for Direct Access (DAX) enabled file systems.

impl MapFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> c_int

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: c_int) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: c_int) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: c_int) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl MapFlags

pub const fn iter(&self) -> Iter<MapFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<MapFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl MapFlags

pub fn map_hugetlb_with_size_log2(huge_page_size_log2: u32) -> Option<Self>

Create MAP_HUGETLB with provided size of huge page.

Under the hood it computes MAP_HUGETLB | (huge_page_size_log2 << libc::MAP_HUGE_SHIFT). huge_page_size_log2 denotes logarithm of huge page size to use and should be between 16 and 63 (inclusively).

let f = MapFlags::map_hugetlb_with_size_log2(30).unwrap();
assert_eq!(f, MapFlags::MAP_HUGETLB | MapFlags::MAP_HUGE_1GB);

Trait Implementations

impl Binary for MapFlags

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

Formats the value using the given formatter.

impl BitAnd for MapFlags

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

The bitwise and (&) of the bits in two flags values.

type Output = MapFlags

The resulting type after applying the & operator.

impl BitAndAssign for MapFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for MapFlags

fn bitor(self, other: MapFlags) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = MapFlags

The resulting type after applying the | operator.

impl BitOrAssign for MapFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for MapFlags

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = MapFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for MapFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for MapFlags

fn clone(&self) -> MapFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MapFlags

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

Formats the value using the given formatter.

impl Extend<MapFlags> for MapFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Flags for MapFlags

const FLAGS: &'static [Flag<MapFlags>] = _

The set of defined flags.

type Bits = i32

The underlying bits type.

fn bits(&self) -> c_int

Get the underlying bits value.

fn from_bits_retain(bits: c_int) -> MapFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<MapFlags> for MapFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl Hash for MapFlags

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for MapFlags

type Item = MapFlags

The type of the elements being iterated over.

type IntoIter = Iter<MapFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for MapFlags

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

Formats the value using the given formatter.

impl Not for MapFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = MapFlags

The resulting type after applying the ! operator.

impl Octal for MapFlags

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

Formats the value using the given formatter.

impl Ord for MapFlags

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MapFlags

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MapFlags

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PublicFlags for MapFlags

type Primitive = i32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for MapFlags

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = MapFlags

The resulting type after applying the - operator.

impl SubAssign for MapFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for MapFlags

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

Formats the value using the given formatter.

impl Copy for MapFlags

impl Eq for MapFlags

impl StructuralPartialEq for MapFlags