Skip to main content

Effect

Enum Effect 

Source
pub enum Effect {
    Pure,
    ReadLocal,
    WriteLocal,
    Network,
    Process,
    Destructive,
    Exec,
    Privileged,
}
Expand description

The effect class of an operation — the single property safety reasons about. Ordered from harmless to most dangerous.

Variants§

§

Pure

No observable effect (pure computation).

§

ReadLocal

Reads local state (filesystem reads, env, process listing).

§

WriteLocal

Creates/modifies local state non-destructively (write, mkdir).

§

Network

Performs network I/O.

§

Process

Affects other processes (kill, signal).

§

Destructive

Irreversibly removes/overwrites local state (rm, truncate, drop).

§

Exec

Executes an arbitrary external command (shell passthrough).

§

Privileged

Requires elevated privileges / affects system-wide state.

Implementations§

Source§

impl Effect

Source

pub fn name(self) -> &'static str

The effect’s canonical snake_case name (inverse of Self::from_name).

Source

pub fn from_name(name: &str) -> Option<Effect>

Parse an effect from its snake_case name (the inverse of Self::name). Accepts the same spellings other effect taxonomies use (e.g. AetherShell’s safety::Effect::as_str), so a host system’s effect classifier can be mapped straight in. Returns None for an unknown name.

Source

pub fn is_dangerous(self) -> bool

Whether this class is “dangerous” — capable of irreversible or out-of-sandbox harm, so it should be gated for an agent.

Source

pub fn all() -> [Effect; 8]

Every effect class, in danger order (harmless → most dangerous). The enumerator for building a complete ontology over the taxonomy.

Source

pub fn summary(self) -> &'static str

A one-line, human/agent-readable summary of what this effect class is.

Source

pub fn decision(self, mode: Mode) -> Decision

The policy Decision for this effect under mode (sugar for decide).

Trait Implementations§

Source§

impl Clone for Effect

Source§

fn clone(&self) -> Effect

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 Copy for Effect

Source§

impl Debug for Effect

Source§

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

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

impl Eq for Effect

Source§

impl Ord for Effect

Source§

fn cmp(&self, other: &Effect) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Effect

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 PartialOrd for Effect

Source§

fn partial_cmp(&self, other: &Effect) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for Effect

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 StructuralPartialEq for Effect

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.