Skip to main content

ReadableCapability

Struct ReadableCapability 

Source
pub struct ReadableCapability<T> { /* private fields */ }
Expand description

Read-only bounds-checked capability. The Write permission bit is silently stripped at construction; no write() method exists.

Layout (24 bytes):

ptr:    *const T   (8 bytes) - base address
base:   usize      (8 bytes) - lower bound (often equals ptr)
length: u32        (4 bytes) - bytes from base
perms:  u32        (4 bytes) - permission bitmask + sealed bit;
                                Write bit guaranteed cleared

Implementations§

Source§

impl<T> ReadableCapability<T>

Source

pub const SIGNATURE: AxisMask

Direction signature of ReadableCapability<T>. Engages the K_bounds axis (runtime base / length / permissions stored at slot for CHERI-style bounds enforcement on every deref).

Source

pub unsafe fn new( ptr: *const T, base: usize, length: u32, perms: u32, ) -> Result<Self, CapabilityError>

§Safety

Caller guarantees [base, base + length) is valid memory for the lifetime of this capability and ptr lies within that region. The Write permission bit is silently stripped.

Source

pub fn from_slice(slice: &[T], perms: u32) -> (ReadableCapability<T>, &[T])

Safe constructor: build a read-only capability over a borrowed slice. Write bit silently stripped.

Source

pub fn has_permission(&self, p: CapabilityPermission) -> bool

Source

pub fn is_sealed(&self) -> bool

Source

pub fn sealed(self) -> Self

Source

pub fn unsealed(self) -> Self

Source

pub fn read(&self) -> Result<T, CapabilityError>
where T: Copy,

Read the value through the capability.

Source

pub fn narrow( &self, sub_base: usize, sub_length: u32, sub_perms: u32, ) -> Result<Self, CapabilityError>

Narrow this capability to a sub-range. Write bit is silently stripped (Readable cannot grant Write).

Trait Implementations§

Source§

impl<T: Clone> Clone for ReadableCapability<T>

Source§

fn clone(&self) -> ReadableCapability<T>

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<T: Copy> Copy for ReadableCapability<T>

Source§

impl<T: Debug> Debug for ReadableCapability<T>

Source§

fn fmt(&self, f: &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> 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<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 = 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.