Struct zircon_object::vm::VmarFlags

pub struct VmarFlags { /* fields omitted */ }

Creation flags for VmAddressRegion.

Implementations

impl VmarFlags

pub const COMPACT: VmarFlags

When randomly allocating subregions, reduce sprawl by placing allocations near each other.

pub const SPECIFIC: VmarFlags

Request that the new region be at the specified offset in its parent region.

pub const SPECIFIC_OVERWRITE: VmarFlags

Like SPECIFIC, but permits overwriting existing mappings. This flag will not overwrite through a subregion.

pub const CAN_MAP_SPECIFIC: VmarFlags

Allow VmMappings to be created inside the new region with the SPECIFIC or OFFSET_IS_UPPER_LIMIT flag.

pub const CAN_MAP_READ: VmarFlags

Allow VmMappings to be created inside the region with read permissions.

pub const CAN_MAP_WRITE: VmarFlags

Allow VmMappings to be created inside the region with write permissions.

pub const CAN_MAP_EXECUTE: VmarFlags

Allow VmMappings to be created inside the region with execute permissions.

pub const REQUIRE_NON_RESIZABLE: VmarFlags

Require that VMO backing the mapping is non-resizable.

pub const ALLOW_FAULTS: VmarFlags

Treat the offset as an upper limit when allocating a VMO or child VMAR.

pub const CAN_MAP_RXW: VmarFlags

Allow VmMappings to be created inside the region with read, write and execute permissions.

pub const ROOT_FLAGS: VmarFlags

Creation flags for root VmAddressRegion

pub const fn empty() -> VmarFlags

Returns an empty set of flags

pub const fn all() -> VmarFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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

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

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> VmarFlags

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for VmarFlags

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

Formats the value using the given formatter.

impl BitAnd<VmarFlags> for VmarFlags

type Output = VmarFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<VmarFlags> for VmarFlags

fn bitand_assign(&mut self, other: VmarFlags)

Disables all flags disabled in the set.

impl BitOr<VmarFlags> for VmarFlags

type Output = VmarFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<VmarFlags> for VmarFlags

fn bitor_assign(&mut self, other: VmarFlags)

Adds the set of flags.

impl BitXor<VmarFlags> for VmarFlags

type Output = VmarFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<VmarFlags> for VmarFlags

fn bitxor_assign(&mut self, other: VmarFlags)

Toggles the set of flags.

impl Clone for VmarFlags

fn clone(&self) -> VmarFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for VmarFlags

impl Debug for VmarFlags

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

Formats the value using the given formatter.

impl Eq for VmarFlags

impl Extend<VmarFlags> for VmarFlags

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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 FromIterator<VmarFlags> for VmarFlags

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

Creates a value from an iterator.

impl Hash for VmarFlags

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

Feeds this value into the given Hasher.

pub 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 VmarFlags

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

Formats the value using the given formatter.

impl Not for VmarFlags

type Output = VmarFlags

The resulting type after applying the ! operator.

fn not(self) -> VmarFlags

Returns the complement of this set of flags.

impl Octal for VmarFlags

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

Formats the value using the given formatter.

impl Ord for VmarFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<VmarFlags> for VmarFlags

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

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

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

This method tests for !=.

impl PartialOrd<VmarFlags> for VmarFlags

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for VmarFlags

impl StructuralPartialEq for VmarFlags

impl Sub<VmarFlags> for VmarFlags

type Output = VmarFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<VmarFlags> for VmarFlags

fn sub_assign(&mut self, other: VmarFlags)

Disables all flags enabled in the set.

impl UpperHex for VmarFlags

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

Formats the value using the given formatter.