Skip to main content

SharedBuf

Struct SharedBuf 

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

A borrowed view of the host’s shared-data buffer for the current call, or none (in which case shared access falls back to the slot model).

The type is not Send/Sync (a NonNull field), matching the single-threaded virtual machine. It owns no memory; the host owns the buffer and outlives the borrow.

Implementations§

Source§

impl SharedBuf

Source

pub fn new() -> Self

An inactive buffer. Shared access uses the slot model until set is called with a non-empty buffer.

Source

pub fn set(&mut self, buf: &mut [u8])

Capture the host buffer for the current call.

An empty slice is treated as “no buffer”: the buffer goes inactive and the caller routes shared access to the slot model. This is the coexistence path for hosts that drive the virtual machine through the plain call/resume and populate shared slots through set_data.

Source

pub fn clear(&mut self)

Release the borrowed buffer. The virtual machine calls this before the call_with_shared/resume_with_shared entry point returns, so a stale pointer is never observable.

Source

pub fn is_active(&self) -> bool

Whether a host buffer is currently borrowed.

Source

pub fn bytes(&self) -> Option<&[u8]>

The borrowed buffer as a shared slice, or None when inactive.

Source

pub fn bytes_mut(&mut self) -> Option<&mut [u8]>

The borrowed buffer as a mutable slice, or None when inactive.

Trait Implementations§

Source§

impl Default for SharedBuf

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> 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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.