Class: Riffer::Agent::StructuredOutput::Result

Inherits:

Object

• Object
• Riffer::Agent::StructuredOutput::Result

Defined in:

lib/riffer/agent/structured_output/result.rb

Overview

Wraps the result of structured output parsing and validation.

Instance Attribute Summary

• #error ⇒ Object readonly

  The error message, or nil on success.

• #object ⇒ Object readonly

  The validated object, or nil on failure.

Instance Method Summary

• #failure? ⇒ Boolean

  Returns true when parsing or validation failed.

• #initialize(object: nil, error: nil) ⇒ Result constructor

  – : (?object: Hash[Symbol, untyped]?, ?error: String?) -> void.

• #success? ⇒ Boolean

  Returns true when parsing and validation succeeded.

Constructor Details

#initialize(object: nil, error: nil) ⇒ Result

– : (?object: Hash[Symbol, untyped]?, ?error: String?) -> void

# File 'lib/riffer/agent/structured_output/result.rb', line 14

def initialize(object: nil, error: nil)
  @object = object
  @error = error
end

Instance Attribute Details

#error ⇒ Object (readonly)

The error message, or nil on success.

# File 'lib/riffer/agent/structured_output/result.rb', line 10

def error
  @error
end

#object ⇒ Object (readonly)

The validated object, or nil on failure.

# File 'lib/riffer/agent/structured_output/result.rb', line 7

def object
  @object
end

Instance Method Details

#failure? ⇒ Boolean

Returns true when parsing or validation failed.

– : () -> bool

Returns:

• (Boolean)

# File 'lib/riffer/agent/structured_output/result.rb', line 29

def failure? = !success?

#success? ⇒ Boolean

Returns true when parsing and validation succeeded.

– : () -> bool

Returns:

• (Boolean)

# File 'lib/riffer/agent/structured_output/result.rb', line 23

def success? = @error.nil?