Enum ctru::os::MemRegion

source ·
#[non_exhaustive]
#[repr(u8)]
pub enum MemRegion { All = 0, Application = 1, System = 2, Base = 3, }
Expand description

A region of memory. Most applications will only use Application memory, but the other types can be used to query memory usage information. See https://www.3dbrew.org/wiki/Memory_layout#FCRAM_memory-regions_layout for more details on the different types of memory.

§Example

let all_memory = ctru::os::MemRegion::All;

assert!(all_memory.size() > 0);
assert!(all_memory.used() > 0);
assert!(all_memory.free() > 0);

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

All = 0

All memory regions.

§

Application = 1

APPLICATION memory.

§

System = 2

SYSTEM memory.

§

Base = 3

BASE memory.

Implementations§

source§

impl MemRegion

source

pub fn size(&self) -> usize

Get the total size of this memory region, in bytes.

source

pub fn used(&self) -> usize

Get the number of bytes used within this memory region.

source

pub fn free(&self) -> usize

Get the number of bytes free within this memory region.

Trait Implementations§

source§

impl Clone for MemRegion

source§

fn clone(&self) -> MemRegion

Returns a copy of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
source§

impl Debug for MemRegion

source§

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

Formats the value using the given formatter. Read more
source§

impl Copy for MemRegion

Auto Trait Implementations§

§

impl RefUnwindSafe for MemRegion

§

impl Send for MemRegion

§

impl Sync for MemRegion

§

impl Unpin for MemRegion

§

impl UnwindSafe for MemRegion

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.