Struct ToolEffect 

pub struct ToolEffect {
    pub kind: ToolEffectKind,
    pub target: String,
    pub reversibility: EffectReversibility,
    pub confirmation: EffectConfirmation,
    pub dry_run: DryRunSupport,
}

Declarative hints about how a tool participates in the runtime.

Fields

kind: ToolEffectKind

The stable effect category.

target: String

Optional target, such as a path, host, channel, or resource name.

reversibility: EffectReversibility

Whether this effect can be undone after execution.

confirmation: EffectConfirmation

Confirmation preference declared by the tool author.

dry_run: DryRunSupport

Dry-run support declared by the tool author.

Implementations

impl ToolEffect

pub const fn new(kind: ToolEffectKind) -> Self

pub fn with_target(self, target: impl Into<String>) -> Self

pub const fn with_reversibility( self, reversibility: EffectReversibility, ) -> Self

pub const fn with_confirmation(self, confirmation: EffectConfirmation) -> Self

pub const fn with_dry_run(self, dry_run: DryRunSupport) -> Self

pub const fn is_mutating(&self) -> bool

pub fn label(&self) -> String

Trait Implementations

impl Clone for ToolEffect

fn clone(&self) -> ToolEffect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolEffect

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolEffect

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolEffect

fn eq(&self, other: &ToolEffect) -> 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 Serialize for ToolEffect

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ToolEffect

impl StructuralPartialEq for ToolEffect