Skip to main content

ToolCompensation

Struct ToolCompensation 

Source
pub struct ToolCompensation {
    pub description: String,
    /* private fields */
}
Expand description

Compensation action for external tool side effects.

ToolCompensation wraps an undo function that compensates for external tool actions (file edits, process spawns, etc.) that cannot be rolled back through normal workflow operations.

Fields§

§description: String

Human-readable description of the compensation

Implementations§

Source§

impl ToolCompensation

Source

pub fn new<F>(description: impl Into<String>, compensate_fn: F) -> Self
where F: Fn(&TaskContext) -> Result<TaskResult, TaskError> + Send + Sync + 'static,

Creates a new ToolCompensation with the given description and undo function.

Source

pub fn execute(&self, context: &TaskContext) -> Result<TaskResult, TaskError>

Executes the compensation action.

Source

pub fn file_compensation(file_path: impl Into<String>) -> Self

Creates a file deletion compensation for undoing file creation.

§Arguments
  • file_path - Path to the file that will be deleted during rollback
§Returns

A ToolCompensation that deletes the specified file

§Example
let comp = ToolCompensation::file_compensation("/tmp/work_output.txt");
Source

pub fn process_compensation(pid: u32) -> Self

Creates a process termination compensation for undoing process spawns.

§Arguments
  • pid - Process ID to terminate
§Returns

A ToolCompensation that terminates the specified process

§Example
let comp = ToolCompensation::process_compensation(12345);
Source

pub fn skip(description: impl Into<String>) -> Self

Creates a skip compensation (no undo needed).

Used for tasks that don’t have side effects or don’t need compensation.

Source

pub fn retry(description: impl Into<String>) -> Self

Creates a retry compensation (recommends retry instead of undo).

Used for transient failures where retry is preferred over compensation.

Trait Implementations§

Source§

impl Clone for ToolCompensation

Source§

fn clone(&self) -> ToolCompensation

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 From<CompensationAction> for ToolCompensation

Source§

fn from(action: CompensationAction) -> Self

Converts to this type from the input type.
Source§

impl From<ProcessGuard> for ToolCompensation

Source§

fn from(guard: ProcessGuard) -> Self

Converts to this type from the input type.

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more