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
impl ShmRingView
Sourcepub fn attach_existing(fleet_name: &str, kind: u8) -> Result<Self>
pub fn attach_existing(fleet_name: &str, kind: u8) -> Result<Self>
Attach to an existing ring owned by the effective user.
Sourcepub fn attach_existing_for_uid(
fleet_name: &str,
kind: u8,
uid: u32,
) -> Result<Self>
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.
Sourcepub fn attach_typed<T: OrbitTyped>(fleet_name: &str) -> Result<Self>
pub fn attach_typed<T: OrbitTyped>(fleet_name: &str) -> Result<Self>
Attach and also verify the caller’s typed ring contract.
pub fn metadata(&self) -> &ShmRingMetadata
Sourcepub fn current_version(&self) -> u64
pub fn current_version(&self) -> u64
Last semantic version allocated by the ring at observation time.
Sourcepub fn notification_generation(&self) -> u32
pub fn notification_generation(&self) -> u32
Current notification generation used by native readiness bridges.
Sourcepub fn lane(&self, lane: usize) -> Result<ShmRingLaneView<'_>>
pub fn lane(&self, lane: usize) -> Result<ShmRingLaneView<'_>>
Select one physical lane as a generic read-only frame source.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for ShmRingView
impl RefUnwindSafe for ShmRingView
impl Send for ShmRingView
impl Sync for ShmRingView
impl Unpin for ShmRingView
impl UnsafeUnpin for ShmRingView
impl UnwindSafe for ShmRingView
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more