Class: Kobako::Snapshot

Inherits:

Object

• Object
• Kobako::Snapshot

Defined in:

lib/kobako/snapshot.rb

Overview

Kobako::Snapshot — per-invocation observable bundle returned from Kobako::Runtime#eval and #run.

The magnus class (see ext/kobako/src/snapshot.rs) carries seven raw readers: return_bytes, stdout_bytes, stdout_truncated, stderr_bytes, stderr_truncated, wall_time, memory_peak. This file reopens the class to add the Ruby-side helpers that pack those raw fields into the user-facing value objects Kobako::Capture and Kobako::Usage — the same shape Kobako::Sandbox exposes to the Host App.

Instance Method Summary

• #stderr ⇒ Object

  Wrap the stderr capture pair as a Kobako::Capture value object.

• #stdout ⇒ Object

  Wrap the stdout capture pair (stdout_bytes, stdout_truncated) as a Kobako::Capture value object.

• #usage ⇒ Object

  Wrap the per-last-invocation usage pair (wall_time, memory_peak) as a Kobako::Usage value object (docs/behavior.md B-35).

Instance Method Details

#stderr ⇒ Object

Wrap the stderr capture pair as a Kobako::Capture value object. Mirror of #stdout.

# File 'lib/kobako/snapshot.rb', line 29

def stderr
  Capture.new(bytes: stderr_bytes, truncated: stderr_truncated)
end

#stdout ⇒ Object

Wrap the stdout capture pair (stdout_bytes, stdout_truncated) as a Kobako::Capture value object. docs/behavior.md B-04 — the byte content never carries a truncation sentinel; #truncated? is the only way to observe that the cap was hit.

# File 'lib/kobako/snapshot.rb', line 23

def stdout
  Capture.new(bytes: stdout_bytes, truncated: stdout_truncated)
end

#usage ⇒ Object

Wrap the per-last-invocation usage pair (wall_time, memory_peak) as a Kobako::Usage value object (docs/behavior.md B-35).

# File 'lib/kobako/snapshot.rb', line 36

def usage
  Usage.new(wall_time: wall_time, memory_peak: memory_peak)
end