Raxol.Terminal.HistoryBuffer (Raxol v2.0.1)

Manages terminal command history buffer operations. This module handles the storage and retrieval of command history.

Summary

Types

t()

Functions

add_command(buffer, command)

Adds a command to the history buffer.

clear(buffer)

Clears the command history.

get_all_commands(buffer)

Gets all commands in history.

get_command_at(buffer, index)

Gets the command at the specified index.

get_max_size(buffer)

Gets the maximum history size.

get_position(buffer)

Gets the current history position.

get_size(buffer)

Gets the history size.

load_from_file(buffer, file_path)

Loads history from a file.

new(max_size \\ 1000)

Creates a new history buffer with the specified maximum size.

next_command(buffer)

Moves to the next command in history.

previous_command(buffer)

Moves to the previous command in history.

save_to_file(buffer, file_path)

Saves the history to a file.

set_max_size(buffer, max_size)

Sets the maximum history size.

set_position(buffer, position)

Sets the history position.

Types

t()

@type t() :: %Raxol.Terminal.HistoryBuffer{
  commands: [String.t()],
  max_size: non_neg_integer(),
  position: integer()
}

Functions

add_command(buffer, command)

@spec add_command(t(), String.t()) :: t()

Adds a command to the history buffer.

clear(buffer)

@spec clear(t()) :: t()

Clears the command history.

get_all_commands(buffer)

@spec get_all_commands(t()) :: [String.t()]

Gets all commands in history.

get_command_at(buffer, index)

@spec get_command_at(t(), integer()) :: {:ok, String.t()} | {:error, String.t()}

Gets the command at the specified index.

get_max_size(buffer)

@spec get_max_size(t()) :: non_neg_integer()

Gets the maximum history size.

get_position(buffer)

@spec get_position(t()) :: integer()

Gets the current history position.

get_size(buffer)

@spec get_size(t()) :: non_neg_integer()

Gets the history size.

load_from_file(buffer, file_path)

@spec load_from_file(t(), String.t()) :: {:ok, t()} | {:error, String.t()}

Loads history from a file.

new(max_size \\ 1000)

@spec new(non_neg_integer()) :: t()

Creates a new history buffer with the specified maximum size.

next_command(buffer)

@spec next_command(t()) :: {:ok, t(), String.t()} | {:error, String.t()}

Moves to the next command in history.

previous_command(buffer)

@spec previous_command(t()) :: {:ok, t(), String.t()} | {:error, String.t()}

Moves to the previous command in history.

save_to_file(buffer, file_path)

@spec save_to_file(t(), String.t()) :: :ok | {:error, String.t()}

Saves the history to a file.

set_max_size(buffer, max_size)

@spec set_max_size(t(), non_neg_integer()) :: t()

Sets the maximum history size.

set_position(buffer, position)

@spec set_position(t(), integer()) :: t()

Sets the history position.