Skip to main content

ShmRingView

Struct ShmRingView 

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

Read-only attachment to one existing Orbit SHM ring.

Attaching never creates, initializes, resets, locks, or unlinks a segment. Dropping the view only unmaps this process’s local mapping. Use ShmRingView::lane to obtain a RingFrameSource for one physical lane.

Implementations§

Source§

impl ShmRingView

Source

pub fn attach_existing(fleet_name: &str, kind: u8) -> Result<Self>

Attach to an existing ring owned by the effective user.

Source

pub fn attach_existing_for_uid( fleet_name: &str, kind: u8, uid: u32, ) -> Result<Self>

Attach to an existing ring under an explicit uid-scoped name.

POSIX permissions still decide whether the calling process may open another user’s object.

Source

pub fn attach_typed<T: OrbitTyped>(fleet_name: &str) -> Result<Self>

Attach and also verify the caller’s typed ring contract.

Source

pub fn metadata(&self) -> &ShmRingMetadata

Source

pub fn current_version(&self) -> u64

Last semantic version allocated by the ring at observation time.

Source

pub fn notification_generation(&self) -> u32

Current notification generation used by native readiness bridges.

Source

pub fn lane(&self, lane: usize) -> Result<ShmRingLaneView<'_>>

Select one physical lane as a generic read-only frame source.

Trait Implementations§

Source§

impl Debug for ShmRingView

Source§

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

Formats the value using the given formatter. 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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.