Skip to main content

Capabilities

Struct Capabilities 

Source
pub struct Capabilities {
    pub fs_read: Vec<PathPattern>,
    pub fs_write: Vec<PathPattern>,
    pub env_read: Vec<String>,
    pub net: Vec<NetPattern>,
    pub stdio: StdioCapability,
}
Expand description

Plugin capability declarations

Plugins declare what system resources they need access to. The host will prompt users to grant these permissions before execution.

§Example

use sen_plugin_api::{Capabilities, PathPattern, StdioCapability};

let caps = Capabilities::default()
    .with_fs_read(vec![PathPattern::new("./data").recursive()])
    .with_fs_write(vec![PathPattern::new("./output")])
    .with_stdio(StdioCapability::stdout_stderr());

Fields§

§fs_read: Vec<PathPattern>

Filesystem read access paths Relative paths resolved from CWD, supports ~ expansion

§fs_write: Vec<PathPattern>

Filesystem write access paths

§env_read: Vec<String>

Environment variable access patterns Supports glob: “MY_*”, exact: “HOME”

§net: Vec<NetPattern>

Network access patterns (WASI Preview 2)

§stdio: StdioCapability

Standard I/O access

Implementations§

Source§

impl Capabilities

Source

pub fn none() -> Self

Create empty capabilities (no permissions)

Source

pub fn is_empty(&self) -> bool

Check if no capabilities are requested

Source

pub fn with_fs_read(self, paths: Vec<PathPattern>) -> Self

Add filesystem read paths

Source

pub fn with_fs_write(self, paths: Vec<PathPattern>) -> Self

Add filesystem write paths

Source

pub fn with_env_read(self, patterns: Vec<String>) -> Self

Add environment variable patterns

Source

pub fn with_net(self, patterns: Vec<NetPattern>) -> Self

Add network patterns

Source

pub fn with_stdio(self, stdio: StdioCapability) -> Self

Set stdio capabilities

Source

pub fn is_subset_of(&self, other: &Capabilities) -> bool

Check if self is a subset of other (all requested capabilities are granted)

Source

pub fn compute_hash(&self) -> String

Compute hash for change detection

Uses blake3 for cross-process stability (unlike DefaultHasher which may produce different hashes across processes/runs).

Trait Implementations§

Source§

impl Clone for Capabilities

Source§

fn clone(&self) -> Capabilities

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Capabilities

Source§

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

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

impl Default for Capabilities

Source§

fn default() -> Capabilities

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

impl<'de> Deserialize<'de> for Capabilities

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Capabilities

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Capabilities

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Capabilities

Source§

impl StructuralPartialEq for Capabilities

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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,