agents-core/ai.koog.agents.core.environment/SafeTool/Result/Success

Success

data class Success<TResult : ToolResult>(val result: TResult, val content: String) : SafeTool.Result<TResult> (source)

Represents a successful result of an operation, wrapping a specific tool result and its corresponding content.

The Success class is a concrete implementation of the Result sealed interface, specifically used to indicate successful outcomes. It stores both the result of type TResult and its associated content as a string.

Parameters

TResult

The type of the tool result, which must implement the ToolResult interface.

Constructors

Success

constructor(result: TResult, content: String)

Properties

content

open override val content: String

The associated content describing or representing the result in string format.

result

val result: TResult

The tool result encapsulated within this success instance.

Functions

asFailure

open fun asFailure(): SafeTool.Result.Failure<TResult>

Casts the current object to a Failure type.

asSuccessful

open fun asSuccessful(): SafeTool.Result.Success<TResult>

Casts the current instance of Result to a Success type if it is a successful result.

isFailure

open fun isFailure(): Boolean

Determines whether the current instance represents a failure state.

isSuccessful

open fun isSuccessful(): Boolean

Determines if the current result represents a successful operation.