Struct region::Protection

pub struct Protection { /* fields omitted */ }

Memory page protection constants.

Determines the access rights for a specific page and/or region. Some combination of flags may not work depending on the OS (e.g macOS enforces pages to be readable).

Examples

use region::Protection;

let combine = Protection::READ | Protection::WRITE;
let shorthand = Protection::READ_WRITE;

Implementations

impl Protection

pub const NONE: Protection

No access allowed at all.

pub const READ: Protection

Read access; writing and/or executing data will panic.

pub const WRITE: Protection

Write access; this flag alone may not be supported on all OSs.

pub const EXECUTE: Protection

Execute access; this may not be allowed depending on DEP.

pub const READ_EXECUTE: Protection

Read and execute shorthand.

pub const READ_WRITE: Protection

Read and write shorthand.

pub const READ_WRITE_EXECUTE: Protection

Read, write and execute shorthand.

pub const WRITE_EXECUTE: Protection

Write and execute shorthand.

pub const None: Protection

👎 Deprecated since 2.2.0:

Use Protection::NONE instead

No access allowed at all.

pub const Read: Protection

👎 Deprecated since 2.2.0:

Use Protection::READ instead

Read access; writing and/or executing data will panic.

pub const Write: Protection

👎 Deprecated since 2.2.0:

Use Protection::WRITE instead

Write access; this flag alone may not be supported on all OSs.

pub const Execute: Protection

👎 Deprecated since 2.2.0:

Use Protection::EXECUTE instead

Execute access; this may not be allowed depending on DEP.

pub const ReadExecute: Protection

👎 Deprecated since 2.2.0:

Use Protection::READ_EXECUTE instead

Read and execute shorthand.

pub const ReadWrite: Protection

👎 Deprecated since 2.2.0:

Use Protection::READ_WRITE instead

Read and write shorthand.

pub const ReadWriteExecute: Protection

👎 Deprecated since 2.2.0:

Use Protection::READ_WRITE_EXECUTE instead

Read, write and execute shorthand.

pub const WriteExecute: Protection

👎 Deprecated since 2.2.0:

Use Protection::WRITE_EXECUTE instead

Write and execute shorthand.

pub const fn empty() -> Protection

Returns an empty set of flags

pub const fn all() -> Protection

Returns the set containing all flags.

pub const fn bits(&self) -> usize

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: usize) -> Option<Protection>

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

pub const fn from_bits_truncate(bits: usize) -> Protection

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

pub const unsafe fn from_bits_unchecked(bits: usize) -> Protection

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for Protection

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

Formats the value using the given formatter.

impl BitAnd<Protection> for Protection

type Output = Protection

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<Protection> for Protection

fn bitand_assign(&mut self, other: Protection)

Disables all flags disabled in the set.

impl BitOr<Protection> for Protection

type Output = Protection

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<Protection> for Protection

fn bitor_assign(&mut self, other: Protection)

Adds the set of flags.

impl BitXor<Protection> for Protection

type Output = Protection

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<Protection> for Protection

fn bitxor_assign(&mut self, other: Protection)

Toggles the set of flags.

impl Clone for Protection

fn clone(&self) -> Protection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Protection

impl Debug for Protection

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

Formats the value using the given formatter.

impl Eq for Protection

impl Extend<Protection> for Protection

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

Extends a collection with the contents of an iterator.

impl FromIterator<Protection> for Protection

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

Creates a value from an iterator.

impl Hash for Protection

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 Protection

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

Formats the value using the given formatter.

impl Not for Protection

type Output = Protection

The resulting type after applying the ! operator.

fn not(self) -> Protection

Returns the complement of this set of flags.

impl Octal for Protection

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

Formats the value using the given formatter.

impl Ord for Protection

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

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

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

#[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<Protection> for Protection

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

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

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

This method tests for !=.

impl PartialOrd<Protection> for Protection

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Protection

impl StructuralPartialEq for Protection

impl Sub<Protection> for Protection

type Output = Protection

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Protection> for Protection

fn sub_assign(&mut self, other: Protection)

Disables all flags enabled in the set.

impl UpperHex for Protection

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

Formats the value using the given formatter.