Struct MapFlags

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

Available on crate feature dep_rustix only.

MAP_* flags for use with mmap.

For MAP_ANONYMOUS (aka MAP_ANON), see mmap_anonymous.

Implementations

impl MapFlags

pub const SHARED: MapFlags

MAP_SHARED

pub const SHARED_VALIDATE: MapFlags

MAP_SHARED_VALIDATE (since Linux 4.15)

pub const PRIVATE: MapFlags

MAP_PRIVATE

pub const DENYWRITE: MapFlags

MAP_DENYWRITE

pub const FIXED: MapFlags

MAP_FIXED

pub const FIXED_NOREPLACE: MapFlags

MAP_FIXED_NOREPLACE (since Linux 4.17)

pub const GROWSDOWN: MapFlags

MAP_GROWSDOWN

pub const HUGETLB: MapFlags

MAP_HUGETLB

pub const HUGE_2MB: MapFlags

MAP_HUGE_2MB (since Linux 3.8)

pub const HUGE_1GB: MapFlags

MAP_HUGE_1GB (since Linux 3.8)

pub const LOCKED: MapFlags

MAP_LOCKED

pub const NORESERVE: MapFlags

MAP_NORESERVE

pub const POPULATE: MapFlags

MAP_POPULATE

pub const STACK: MapFlags

MAP_STACK

pub const SYNC: MapFlags

MAP_SYNC (since Linux 4.15)

pub const UNINITIALIZED: MapFlags

MAP_UNINITIALIZED

pub const DROPPABLE: MapFlags

MAP_DROPPABLE

impl MapFlags

pub const fn empty() -> MapFlags

Get a flags value with all bits unset.

pub const fn all() -> MapFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

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

pub const fn from_bits(bits: u32) -> Option<MapFlags>

Convert from a bits value.

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

pub const fn from_bits_truncate(bits: u32) -> MapFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> MapFlags

Convert from a bits value exactly.

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

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: MapFlags) -> bool

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

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

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

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

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

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

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: MapFlags)

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

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

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

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

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

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

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

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

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: MapFlags) -> MapFlags

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

pub const fn complement(self) -> MapFlags

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 const fn hugetlb_with_size_log2( huge_page_size_log2: u32, ) -> Option<MapFlags>

Create MAP_HUGETLB with provided size of huge page.

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

use rustix::mm::MapFlags;

let f = MapFlags::hugetlb_with_size_log2(30).unwrap();
assert_eq!(f, MapFlags::HUGETLB | MapFlags::HUGE_1GB);

Trait Implementations

impl Binary for MapFlags

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

Formats the value using the given formatter.

impl BitAnd for MapFlags

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

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: MapFlags)

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

impl BitOr for MapFlags

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

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: MapFlags)

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

impl BitXor for MapFlags

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

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: MapFlags)

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<(), Error>

Formats the value using the given formatter.

impl Extend<MapFlags> for MapFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = MapFlags>,

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 = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> 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 contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are 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 truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

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>(iterator: T) -> MapFlags

where T: IntoIterator<Item = MapFlags>,

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

impl Hash for MapFlags

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

where __H: Hasher,

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) -> <MapFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for MapFlags

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

Formats the value using the given formatter.

impl Not for MapFlags

fn not(self) -> MapFlags

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<(), Error>

Formats the value using the given formatter.

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 Sub for MapFlags

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

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: MapFlags)

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<(), Error>

Formats the value using the given formatter.

impl Copy for MapFlags

impl Eq for MapFlags

impl StructuralPartialEq for MapFlags