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

Failure

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

Represents a failure result in the context of a result model.

This class is a concrete implementation of the Result sealed interface, specifically used to represent a failure case. It contains an error message that can be used to describe the failure or provide additional context about the error.

Parameters

TResult

The type parameter representing the type of the result in successful cases.

Constructors

Failure

constructor(message: String)

Properties

content

open override val content: String

Provides access to the error message associated with the failure result. Retrieves the content as a string representation of the error message.

message

val message: String

A string containing the error message or details about the failure.

Functions

asFailure

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

Casts the current Result instance to a Failure type.

asSuccessful

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

Casts the current Result instance to Success<TResult>.

isFailure

open fun isFailure(): Boolean

Checks whether the current instance represents a failure result.

isSuccessful

open fun isSuccessful(): Boolean

Determines whether the current Result instance represents a successful outcome.