Struct QuiescentRegion 

pub struct QuiescentRegion { /* private fields */ }

Quiescent, pre-transfer owner of a zero-initialized Mach mapping.

This is the only typestate that exposes ordinary byte slices. Consuming it chooses the one writer direction and permanently removes those accessors.

Implementations

impl QuiescentRegion

pub fn new(len: usize) -> Result<Self, MachError>

Allocates a non-executable, zero-initialized Mach VM region.

Examples found in repository

examples/quiescent_region.rs (line 16)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut region = native_ipc_platform::macos::QuiescentRegion::new(256)?;
    initialize(&mut region.as_bytes_mut()[..256]);
    println!("Mach VM capability: {} page-rounded bytes", region.len());
    Ok(())
}

pub const fn len(&self) -> usize

Returns the negotiated page-rounded capability length.

Examples found in repository

examples/quiescent_region.rs (line 18)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut region = native_ipc_platform::macos::QuiescentRegion::new(256)?;
    initialize(&mut region.as_bytes_mut()[..256]);
    println!("Mach VM capability: {} page-rounded bytes", region.len());
    Ok(())
}

pub const fn logical_len(&self) -> usize

Returns the requested logical layout length within the capability.

pub const fn is_empty(&self) -> bool

Returns whether the logical region is empty (always false for a valid value).

pub fn as_bytes(&self) -> &[u8]

Borrows quiescent initialization bytes.

pub fn as_bytes_mut(&mut self) -> &mut [u8]

Mutably borrows quiescent initialization bytes.

Examples found in repository

examples/quiescent_region.rs (line 17)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut region = native_ipc_platform::macos::QuiescentRegion::new(256)?;
    initialize(&mut region.as_bytes_mut()[..256]);
    println!("Mach VM capability: {} page-rounded bytes", region.len());
    Ok(())
}

pub fn into_local_writer( self, expected_len: usize, ) -> Result<LocalWriterRegion, MachError>

Selects this process as sole writer and creates one read-only peer entry.

pub fn into_remote_writer( self, expected_len: usize, ) -> Result<RemoteWriterRegion, MachError>

Selects the peer as sole writer and permanently downgrades this mapping.

pub fn into_bound_local_writer( self, expected: ValidationExpectations, topology: RegionSetLayout, ) -> Result<WriterRegion<MacWriterMapping>, MacBindingError>

Validates the complete padded capability, then consumes it as the sole writer.

pub fn into_bound_remote_writer( self, expected: ValidationExpectations, topology: RegionSetLayout, ) -> Result<ReaderRegion<MacReaderMapping>, MacBindingError>

Validates the complete padded capability, then downgrades it to read-only.

pub fn transfer_local_writer( self, expected: ValidationExpectations, topology: RegionSetLayout, channel: &ParentChannel, ) -> Result<WriterRegion<TransferredWriterMapping>, MacBindingError>

Validates, transfers a read-only entry, and commits the local writer.

pub fn transfer_remote_writer( self, expected: ValidationExpectations, topology: RegionSetLayout, channel: &ParentChannel, ) -> Result<ReaderRegion<TransferredReaderMapping>, MacBindingError>

Validates, transfers the sole writer entry, and commits local read-only access.

Trait Implementations

impl Debug for QuiescentRegion

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

Formats the value using the given formatter.