inspector/lib/repl.mli
2026-03-13 23:27:28 +01:00

21 lines
894 B
OCaml
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

(** Interactive command loop for the inspector.
The REPL (ReadEvalPrint Loop) repeatedly reads commands from standard
input and applies them to the current navigation state.
Each command may update the state (for example moving the cursor) or display
information about the current log line.
The loop continues until the user enters ["quit"] or ["exit"], or until an
end-of-file condition is encountered on standard input (for example when
pressing Ctrl-D). *)
val loop : State.t -> unit
(** [loop state] starts the interactive command loop.
The given [state] represents the current navigation state of the loaded log
file. Commands executed by the user may derive new states (for example via
{!State.next} or {!State.prev}) which are then used in the next iteration of
the loop.
The function runs until the user exits the program. *)