StateFileBackend

org.llm4s.agent.harness.StateFileBackend
See theStateFileBackend companion object
@Experimental
final class StateFileBackend extends FileBackend

The default FileBackend: files in thread state, under one key of its own (files, id keyId). They are committed with the call that wrote them, so they are part of every checkpoint, of history and of fork, and a mutation needs no replay guard: its effect is the update the runtime commits.

Directories are implicit: a path is a directory when an entry lies beneath it. Every mutation holds the lock files/state/<keyId>, so the mutations of one batch apply in call order, each against the state the previous one committed. That makes the bounds exact: the total bytes of paths and contents, as JSON strings (what a checkpoint stores, escapes included), is at most maxBytes, and the number of files at most maxFiles, checked when the tool runs (rules 1, 2, 12).

Each checkpoint copies the whole map (rule 6), so pair the backend with a RetentionPolicy.

The lock is what keeps two edits of one file in a batch from losing one, and the bounds exact: the calls of a batch otherwise share one snapshot. Adding tools over this backend to an existing agent adds the files key and the loop's tool-queue: a thread at rest continues with no files, and one in flight is refused until it is finished (ยง4.29). The last file's delete removes the key's entry, so taking the tools out again refuses only a thread that still holds files.

Attributes

Companion
object
Graph
Supertypes
trait FileBackend
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

Deletes the file, or the empty directory, path.

Deletes the file, or the empty directory, path.

Attributes

def edit(path: VPath, old: String, replacement: String, replaceAll: Boolean, ctx: FileContext): Result[(FileEdited, StateUpdate)]

Replaces old with replacement in the file path: the one occurrence, or every occurrence when replaceAll. Refused when old is empty or absent, or occurs more than once and not replaceAll.

Replaces old with replacement in the file path: the one occurrence, or every occurrence when replaceAll. Refused when old is empty or absent, or occurs more than once and not replaceAll.

Attributes

def find(under: VPath, accept: VPath => Boolean, limit: Int, ctx: FileContext): Result[Listing[VPath]]

The files within under that accept takes, in path order, at most limit: accept is applied before the limit, so a file it refuses never takes a place (a composite passes a predicate that refuses the paths a mount shadows, and relies on this to fill its limit with visible files). search likewise.

The files within under that accept takes, in path order, at most limit: accept is applied before the limit, so a file it refuses never takes a place (a composite passes a predicate that refuses the paths a mount shadows, and relies on this to fill its limit with visible files). search likewise.

Attributes

def locks(path: VPath): Set[LockKey]

The locks a mutation of path holds.

The locks a mutation of path holds.

Attributes

def ls(path: VPath, limit: Int, ctx: FileContext): Result[Listing[FileInfo]]

The entries directly beneath the directory path, in path order, at most limit.

The entries directly beneath the directory path, in path order, at most limit.

Attributes

def read(path: VPath, offset: Int, limit: Int, ctx: FileContext): Result[FileLines]

At most limit lines of the file path, from the 0-based line offset.

At most limit lines of the file path, from the 0-based line offset.

Attributes

def search(under: VPath, regex: Pattern, accept: VPath => Boolean, limit: Int, ctx: FileContext): Result[Listing[GrepMatch]]

The lines matching regex of the files within under that accept takes, in path then line order. regex is the model's: match it with org.llm4s.security.RegexSafetyManager.safeFind, never a bare matcher, so a catastrophic pattern is bounded and cannot overflow the stack.

The lines matching regex of the files within under that accept takes, in path then line order. regex is the model's: match it with org.llm4s.security.RegexSafetyManager.safeFind, never a bare matcher, so a catastrophic pattern is bounded and cannot overflow the stack.

Attributes

def write(path: VPath, content: String, ctx: FileContext): Result[(FileWritten, StateUpdate)]

Writes the file path, creating it or replacing it.

Writes the file path, creating it or replacing it.

Attributes

Inherited methods

final def glob(pattern: Glob, under: VPath, limit: Int, ctx: FileContext): Result[Listing[VPath]]

The files within under whose path relative to under matches pattern.

The files within under whose path relative to under matches pattern.

Attributes

Inherited from:
FileBackend
final def grep(regex: String, under: VPath, include: Option[Glob], limit: Int, ctx: FileContext): Result[Listing[GrepMatch]]

The lines matching regex in the files within under. include filters the files: a pattern with no / matches a file's name, one with a / its path relative to under (as ripgrep's --glob).

The lines matching regex in the files within under. include filters the files: a pattern with no / matches a file's name, one with a / its path relative to under (as ripgrep's --glob).

Attributes

Inherited from:
FileBackend

Concrete fields

The key the files live in.

The key the files live in.

Attributes

val maxBytes: Long
val maxFiles: Int
val writes: Set[StateKey[_, _]]

The state keys the StateUpdates of this backend's mutations touch; a tool declares them in writes.

The state keys the StateUpdates of this backend's mutations touch; a tool declares them in writes.

Attributes