Skip to main content

GroupAccess

Struct GroupAccess 

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

Access to one deployment-owned IPC directory and its named SHM objects.

All group writers are trusted peers, not isolated principals. The owner prepares lock inodes; other users only attach. The parent directory must be provisioned by the operator and protected from untrusted replacement. No credentials, umask, existing permissions or unrelated resources change.

Implementations§

Source§

impl GroupAccess

Source

pub fn new(owner: u32, gid: u32, directory: impl AsRef<Path>) -> Result<Self>

Source

pub fn owner_uid(&self) -> u32

Source

pub fn gid(&self) -> u32

Source

pub fn directory(&self) -> &Path

Source

pub fn is_owner(&self) -> bool

Source

pub fn segment_name(&self, fleet: &str, kind: u8) -> String

Scope the SHM name to the same owner/group/directory as its kernel locks. This prevents two IPC directories from supplying different death locks for the same mapped inbox. The name also fits Darwin’s 31-byte limit.

Source

pub fn prepare(&self) -> Result<()>

Prepare once as owner; attaching peers never create directories.

Source

pub fn prepare_locks(&self, segment: &str, lanes: usize) -> Result<()>

Prepare bounded lane/watcher lock files before publishing the inbox.

Source

pub fn open_region( &self, name: &str, size: usize, ) -> Result<(ShmRegion, ShmRegionLock)>

Remove only a group-shared name. Persistent lock inodes are not removed on restart and private per-UID companion directories are never visited. All participants must already be stopped, as with ordinary SHM unlink.

Source

pub fn try_hold_lane( &self, segment: &str, lane: usize, ) -> Result<Option<LaneHold>>

Source

pub fn try_hold_watcher( &self, segment: &str, slot: usize, ) -> Result<Option<WatcherHold>>

Source

pub fn bell_path(&self, segment: &str, suffix: &str) -> PathBuf

The group-writable bell directory is separate from immutable lock names. A caller must own the corresponding lane before binding/removing a bell.

Source

pub fn bind_bell(&self, path: &Path) -> Result<UnixDatagram>

Trait Implementations§

Source§

impl Clone for GroupAccess

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GroupAccess

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for GroupAccess

Source§

impl Hash for GroupAccess

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for GroupAccess

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for GroupAccess

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.