Struct sunrise_libkern::MemoryState

pub struct MemoryState {
    bits: u32,
}

Represents the current state of a memory region: why is it allocated, and what operations are allowed.

Fields

bits: u32

Implementations

impl MemoryState

pub const TY: MemoryState

The low 8 bits are used to keep the type.

pub const PERMISSION_CHANGE_ALLOWED: MemoryState

Allows the use of svcSetMemoryPermissions on this memory region.

pub const FORCE_READ_WRITABLE_BY_DEBUG_SYSCALLS: MemoryState

Allow writing to read-only segments with svcWriteDebugProcessMemory.

pub const IPC_SEND_ALLOWED: MemoryState

Allows sending this region over IPC.

pub const NON_DEVICE_IPC_SEND_ALLOWED: MemoryState

Allows sending this region over IPC with buffer flag set to 1.

pub const NON_SECURE_IPC_SEND_ALLOWED: MemoryState

Allows sending this region over IPC with buffer flag set to 3.

pub const PROCESS_PERMISSION_CHANGE_ALLOWED: MemoryState

Allows the use of svcSetProcessMemoryPermission on this memory region.

pub const MAP_ALLOWED: MemoryState

Allows remapping this memory region with svcMapMemory.

pub const UNMAP_PROCESS_CODE_MEMORY_ALLOWED: MemoryState

Allows unmapping this memory region through svcUnmapProcessCodeMemory.

pub const TRANSFER_MEMORY_ALLOWED: MemoryState

Allows creating Transfer Memory from this memory region with svcCreateTransferMemory.

pub const QUERY_PHYSICAL_ADDRESS_ALLOWED: MemoryState

Allows using query_physical_memory on this memory region.

pub const MAP_DEVICE_ALLOWED: MemoryState

Allows mapping this memory region to a DeviceAddressSpace through either svcMapDeviceAddressSpace or svcMapDeviceAddressSpaceByForce.

pub const MAP_DEVICE_ALIGNED_ALLOWED: MemoryState

Allows mapping this memory region to a DeviceAddressSpace through svcMapDeviceAddressSpaceAligned.

pub const IPC_BUFFER_ALLOWED: MemoryState

Allows using this memory region as an IPC Command Buffer.

pub const IS_REFERENCE_COUNTED: MemoryState

If true, this memory region is reference counted/pool-allocated.

pub const MAP_PROCESS_ALLOWED: MemoryState

Allows mapping this region accross process boundary through svcMapProcessMemory

pub const ATTRIBUTE_CHANGE_ALLOWED: MemoryState

Allows using the svcSetMemoryAttribute syscall on this memory region.

pub const CODE_MEMORY_ALLOWED: MemoryState

Allows creating a CodeMemory backed by this memory region.

pub const ALL_IPC_SEND_ALLOWED: MemoryState

All IPC Buffer Send permissions are allowed by this type.

pub const CAN_IOMMU: MemoryState

This type can use all IOMMU-related permissions (MapDevice allowed, MapDeviceAligned allowed, and QueryPhysicalAddress allowed).

pub const fn empty() -> MemoryState

Returns an empty set of flags

pub const fn all() -> MemoryState

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<MemoryState>

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) -> MemoryState

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl MemoryState

pub fn ty(self) -> MemoryType

MemoryType this state represents.

Trait Implementations

impl Binary for MemoryState

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

Formats the value using the given formatter.

impl BitAnd<MemoryState> for MemoryState

type Output = MemoryState

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<MemoryState> for MemoryState

fn bitand_assign(&mut self, other: MemoryState)

Disables all flags disabled in the set.

impl BitOr<MemoryState> for MemoryState

type Output = MemoryState

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<MemoryState> for MemoryState

fn bitor_assign(&mut self, other: MemoryState)

Adds the set of flags.

impl BitXor<MemoryState> for MemoryState

type Output = MemoryState

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<MemoryState> for MemoryState

fn bitxor_assign(&mut self, other: MemoryState)

Toggles the set of flags.

impl Clone for MemoryState

fn clone(&self) -> MemoryState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MemoryState

impl Debug for MemoryState

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

Formats the value using the given formatter.

impl Default for MemoryState

fn default() -> MemoryState

Returns the "default value" for a type.

impl Eq for MemoryState

impl Extend<MemoryState> for MemoryState

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

Extends a collection with the contents of an iterator.

impl FromIterator<MemoryState> for MemoryState

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

Creates a value from an iterator.

impl Hash for MemoryState

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 MemoryState

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

Formats the value using the given formatter.

impl Not for MemoryState

type Output = MemoryState

The resulting type after applying the ! operator.

fn not(self) -> MemoryState

Returns the complement of this set of flags.

impl Octal for MemoryState

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

Formats the value using the given formatter.

impl Ord for MemoryState

fn cmp(&self, other: &MemoryState) -> 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<MemoryState> for MemoryState

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

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

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

This method tests for !=.

impl PartialOrd<MemoryState> for MemoryState

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for MemoryState

impl StructuralPartialEq for MemoryState

impl Sub<MemoryState> for MemoryState

type Output = MemoryState

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<MemoryState> for MemoryState

fn sub_assign(&mut self, other: MemoryState)

Disables all flags enabled in the set.

impl UpperHex for MemoryState

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

Formats the value using the given formatter.