Struct nix::sys::mman::MapFlags

[+] Show declaration

pub struct MapFlags { /* fields omitted */ }

[−] Expand description

Additional parameters for mmap().

Methods

impl MapFlags[−]

pub const MAP_FILE: MapFlags[−][−]

Compatibility flag. Ignored.

pub const MAP_SHARED: MapFlags[−][−]

Share this mapping. Mutually exclusive with MAP_PRIVATE.

pub const MAP_PRIVATE: MapFlags[−][−]

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

pub const MAP_FIXED: MapFlags[−][−]

Place the mapping at exactly the address specified in addr.

pub const MAP_ANON: MapFlags[−][−]

Synonym for MAP_ANONYMOUS.

pub const MAP_ANONYMOUS: MapFlags[−][−]

The mapping is not backed by any file.

pub const MAP_32BIT: MapFlags[−][−]

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

pub const MAP_GROWSDOWN: MapFlags[−][−]

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

pub const MAP_DENYWRITE: MapFlags[−][−]

Compatibility flag. Ignored.

pub const MAP_EXECUTABLE: MapFlags[−][−]

Compatibility flag. Ignored.

pub const MAP_LOCKED: MapFlags[−][−]

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

pub const MAP_NORESERVE: MapFlags[−][−]

Do not reserve swap space for this mapping.

This was removed in FreeBSD 11.

pub const MAP_POPULATE: MapFlags[−][−]

Populate page tables for a mapping.

pub const MAP_NONBLOCK: MapFlags[−][−]

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

pub const MAP_HUGETLB: MapFlags[−][−]

Allocate the mapping using "huge pages."

pub const MAP_STACK: MapFlags[−][−]

Region grows down, like a stack.

pub const fn empty() -> MapFlags[−]

Returns an empty set of flags

pub const fn all() -> MapFlags[−]

Returns the set containing all flags.

pub const fn bits(&self) -> c_int[−]

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: c_int) -> Option<MapFlags>[−]

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: c_int) -> MapFlags[−]

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: c_int) -> MapFlags[−]

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool[−]

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool[−]

Returns true if all flags are currently set.

pub const fn intersects(&self, other: MapFlags) -> bool[−]

Returns true if there are flags common to both self and other.

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

Returns true all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

pub fn toggle(&mut self, other: MapFlags)[−]

Toggles the specified flags in-place.

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

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for MapFlags[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl BitAnd<MapFlags> for MapFlags[+]

type Output = MapFlags

The resulting type after applying the & operator.

fn bitand(self, other: MapFlags) -> MapFlags[−]

Returns the intersection between the two sets of flags.

impl BitAndAssign<MapFlags> for MapFlags[+]

fn bitand_assign(&mut self, other: MapFlags)[−]

Disables all flags disabled in the set.

impl BitOr<MapFlags> for MapFlags[+]

type Output = MapFlags

The resulting type after applying the | operator.

fn bitor(self, other: MapFlags) -> MapFlags[−]

Returns the union of the two sets of flags.

impl BitOrAssign<MapFlags> for MapFlags[+]

fn bitor_assign(&mut self, other: MapFlags)[−]

Adds the set of flags.

impl BitXor<MapFlags> for MapFlags[+]

type Output = MapFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: MapFlags) -> MapFlags[−]

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<MapFlags> for MapFlags[+]

fn bitxor_assign(&mut self, other: MapFlags)[−]

Toggles the set of flags.

impl Clone for MapFlags[+]

[+] Show hidden undocumented items

fn clone(&self) -> MapFlags[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for MapFlags

impl Debug for MapFlags[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Eq for MapFlags

impl Extend<MapFlags> for MapFlags[+]

[+] Show hidden undocumented items

fn extend<T: IntoIterator<Item = MapFlags>>(&mut self, iterator: T)[−]

Extends a collection with the contents of an iterator.

impl FromIterator<MapFlags> for MapFlags[+]

[+] Show hidden undocumented items

fn from_iter<T: IntoIterator<Item = MapFlags>>(iterator: T) -> MapFlags[−]

Creates a value from an iterator.

impl Hash for MapFlags[+]

[+] Show hidden undocumented items

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 LowerHex for MapFlags[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Not for MapFlags[+]

type Output = MapFlags

The resulting type after applying the ! operator.

fn not(self) -> MapFlags[−]

Returns the complement of this set of flags.

impl Octal for MapFlags[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Ord for MapFlags[+]

[+] Show hidden undocumented items

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

This method returns an [Ordering] between self and other.

[+] Expand attributes

#[must_use] fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use] fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use] fn clamp(self, min: Self, max: Self) -> Self[−]

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

Restrict a value to a certain interval.

impl PartialEq<MapFlags> for MapFlags[+]

[+] Show hidden undocumented items

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

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

fn ne(&self, other: &MapFlags) -> bool[−]

This method tests for !=.

impl PartialOrd<MapFlags> for MapFlags[+]

[+] Show hidden undocumented items

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: &MapFlags) -> bool[−]

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

fn le(&self, other: &MapFlags) -> bool[−]

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

fn gt(&self, other: &MapFlags) -> bool[−]

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

fn ge(&self, other: &MapFlags) -> bool[−]

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

impl StructuralEq for MapFlags

impl StructuralPartialEq for MapFlags

impl Sub<MapFlags> for MapFlags[+]

type Output = MapFlags

The resulting type after applying the - operator.

fn sub(self, other: MapFlags) -> MapFlags[−]

Returns the set difference of the two sets of flags.

impl SubAssign<MapFlags> for MapFlags[+]

fn sub_assign(&mut self, other: MapFlags)[−]

Disables all flags enabled in the set.

impl UpperHex for MapFlags[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.