Skip to main content

NativeMemoryCapabilities

Struct NativeMemoryCapabilities 

Source
pub struct NativeMemoryCapabilities { /* private fields */ }
Expand description

Cross-platform capabilities of the selected native backend.

Implementations§

Source§

impl NativeMemoryCapabilities

Source

pub const fn platform(self) -> NativePlatform

Selected operating-system backend.

Examples found in repository?
examples/common_memory.rs (line 17)
5fn main() -> Result<(), Box<dyn std::error::Error>> {
6    let capabilities = native_memory_capabilities();
7    let options = RegionOptions::growable(128, 4096, WriterOwner::Creator);
8    let mut region = NativeRegion::allocate(options)?;
9
10    region.initialize(|bytes| bytes[..8].copy_from_slice(b"NIPCDEMO"));
11    region.grow(512)?;
12    region.initialize(|bytes| assert_eq!(&bytes[..8], b"NIPCDEMO"));
13
14    let status = region.status();
15    println!(
16        "backend={:?} authority={:?} logical={} mapped={} maximum={}",
17        capabilities.platform(),
18        capabilities.authority_mechanism(),
19        status.logical_len,
20        status.mapped_len,
21        status.maximum_len,
22    );
23
24    region.clear();
25    region.initialize(|bytes| bytes[..8].copy_from_slice(b"REUSABLE"));
26
27    // `destroy` explicitly clears the complete mapping before releasing it.
28    // Use `prepare_for_sharing` instead when handing the region to the
29    // authenticated platform transfer typestate.
30    region.destroy();
31    Ok(())
32}
Source

pub const fn architecture(self) -> NativeArchitecture

Selected processor architecture.

Source

pub const fn authority_mechanism(self) -> AuthorityMechanism

Native mechanism used to freeze or attenuate authority.

Examples found in repository?
examples/common_memory.rs (line 18)
5fn main() -> Result<(), Box<dyn std::error::Error>> {
6    let capabilities = native_memory_capabilities();
7    let options = RegionOptions::growable(128, 4096, WriterOwner::Creator);
8    let mut region = NativeRegion::allocate(options)?;
9
10    region.initialize(|bytes| bytes[..8].copy_from_slice(b"NIPCDEMO"));
11    region.grow(512)?;
12    region.initialize(|bytes| assert_eq!(&bytes[..8], b"NIPCDEMO"));
13
14    let status = region.status();
15    println!(
16        "backend={:?} authority={:?} logical={} mapped={} maximum={}",
17        capabilities.platform(),
18        capabilities.authority_mechanism(),
19        status.logical_len,
20        status.mapped_len,
21        status.maximum_len,
22    );
23
24    region.clear();
25    region.initialize(|bytes| bytes[..8].copy_from_slice(b"REUSABLE"));
26
27    // `destroy` explicitly clears the complete mapping before releasing it.
28    // Use `prepare_for_sharing` instead when handing the region to the
29    // authenticated platform transfer typestate.
30    region.destroy();
31    Ok(())
32}
Source

pub const fn supports_replacement_growth(self) -> bool

Whether a private region can grow by allocating a replacement mapping.

Source

pub const fn supports_in_place_growth(self) -> bool

Whether a shared mapping can grow in place.

Source

pub const fn supports_post_share_permission_changes(self) -> bool

Whether permission changes are accepted after sharing.

Source

pub const fn releases_on_drop(self) -> bool

Whether dropping all owners automatically releases the anonymous object.

Trait Implementations§

Source§

impl Clone for NativeMemoryCapabilities

Source§

fn clone(&self) -> NativeMemoryCapabilities

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for NativeMemoryCapabilities

Source§

impl Debug for NativeMemoryCapabilities

Source§

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

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

impl Eq for NativeMemoryCapabilities

Source§

impl PartialEq for NativeMemoryCapabilities

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for NativeMemoryCapabilities

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.