Enum Effect 

pub enum Effect {
    ReadOnly,
    LocalMutation,
    RepositoryMutation,
    NetworkMutation,
    Destructive,
}

What running a command changes. The one thing a surface policy is allowed to ask.

The order is the order of increasing consequence, and it is the order the derived exposure policy reads: a surface declares the strongest effect it will carry, and every node at or below it is projected there. Nothing configures a surface per command.

Variants

ReadOnly

Reads and answers. Changes nothing anywhere.

LocalMutation

Writes only where the repository keeps a checkout’s own state — the process’s memory, .ai/local/, a build directory. Nothing a commit would carry.

RepositoryMutation

Writes tracked files: generated artifacts, the worktree, git itself.

NetworkMutation

Reaches the network with an effect on the far side: a push, a deploy, a release.

Destructive

Removes something a person would have to reconstruct.

Implementations

impl Effect

pub fn of_capability(policy: ExecutionPolicy) -> Self

The effect of a capability, from the execution policy the registry classified.

Read from the policy rather than from the kind alone, because the kind cannot tell the two commands apart: announcing a peer changes this process’s memory, and moving an issue writes a tracked file a commit will carry. This function is what the exposure policy consults — a surface carries every node at or below the strongest effect it declares — so a capability whose effect was understated here would be projected onto a surface whose ceiling exists to exclude it.

pub fn is_read_only(self) -> bool

Does this effect leave the repository as it found it?

Trait Implementations

impl Clone for Effect

fn clone(&self) -> Effect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Effect

impl Debug for Effect

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Effect

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Effect

impl JsonSchema for Effect

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for Effect

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Effect

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Effect

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Effect

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Effect