Struct RegionOptions 

pub struct RegionOptions { /* private fields */ }

Immutable configuration for one native shared-memory region.

Implementations

impl RegionOptions

pub const fn fixed(logical_len: usize, writer: WriterOwner) -> Self

Creates a fixed-size region with clear-on-drop cleanup.

pub const fn growable( logical_len: usize, maximum_len: usize, writer: WriterOwner, ) -> Self

Creates a private growable region with clear-on-drop cleanup.

Growth allocates a replacement mapping. It is never available after the region is consumed for native sharing.

Examples found in repository

examples/common_memory.rs (line 7)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let capabilities = native_memory_capabilities();
    let options = RegionOptions::growable(128, 4096, WriterOwner::Creator);
    let mut region = NativeRegion::allocate(options)?;

    region.initialize(|bytes| bytes[..8].copy_from_slice(b"NIPCDEMO"));
    region.grow(512)?;
    region.initialize(|bytes| assert_eq!(&bytes[..8], b"NIPCDEMO"));

    let status = region.status();
    println!(
        "backend={:?} authority={:?} logical={} mapped={} maximum={}",
        capabilities.platform(),
        capabilities.authority_mechanism(),
        status.logical_len,
        status.mapped_len,
        status.maximum_len,
    );

    region.clear();
    region.initialize(|bytes| bytes[..8].copy_from_slice(b"REUSABLE"));

    // `destroy` explicitly clears the complete mapping before releasing it.
    // Use `prepare_for_sharing` instead when handing the region to the
    // authenticated platform transfer typestate.
    region.destroy();
    Ok(())
}

pub const fn with_cleanup(self, cleanup: CleanupPolicy) -> Self

Overrides cleanup behavior before the native sharing transition.

pub const fn logical_len(self) -> usize

Initial logical bytes requested by the caller.

pub const fn growth(self) -> GrowthPolicy

Private growth policy.

pub const fn cleanup(self) -> CleanupPolicy

Pre-transfer cleanup policy.

pub const fn permissions(self) -> PermissionPlan

Required one-writer permission plan.

pub const fn seal(self) -> SealPolicy

Mandatory native authority-sealing behavior.

pub const fn maximum_len(self) -> usize

Inclusive logical capacity limit.

Trait Implementations

impl Clone for RegionOptions

fn clone(&self) -> RegionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RegionOptions

impl Debug for RegionOptions

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

Formats the value using the given formatter.

impl Eq for RegionOptions

impl PartialEq for RegionOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RegionOptions