Struct ClearPlan 

pub struct ClearPlan {
    pub cleared: Cleared,
    pub through: Option<MessageId>,
    /* private fields */
}

The tool outputs a clearing replaces (ClearToolOutputs::plan), by message id.

Fields

cleared: Cleared

What applying it takes out, as planned.

through: Option<MessageId>

The newest message holding an output it clears, after whose outputs notes go; None when it clears nothing.

Implementations

impl ClearPlan

pub fn results<'c>( &self, conversation: &'c Conversation, ) -> impl Iterator<Item = &'c ToolResult>

The tool results of conversation it clears.

pub fn apply( &self, conversation: &mut Conversation, notes: Option<&str>, by: Author, ) -> Cleared

Replaces the outputs it clears in conversation with the placeholder, with notes, if any, as a text part after through’s, by one Conversation::edit_each by by. Returns what it planned to take out.

Trait Implementations

impl Clone for ClearPlan

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClearPlan

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

Formats the value using the given formatter.

impl Default for ClearPlan

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ClearPlan

impl PartialEq for ClearPlan

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClearPlan