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

Failure

data class Failure<TResult : ToolResult>(val message: String) : SafeTool.Result<TResult> (source)

Represents a failed result encapsulating an error message.

This class extends the base Result interface and is used to indicate that a particular operation has failed. The associated failure message provides additional context or details about the failure.

Parameters

TResult

The type of the tool result associated with the operation.

Constructors

Failure

constructor(message: String)

Properties

content

open override val content: String

Returns the failure message associated with this result.

message

val message: String

A descriptive error message explaining the reason for the failure.

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.