Raxol.Terminal.Scroll.Manager (Raxol v2.0.1)

@type t() :: %Raxol.Terminal.Scroll.Manager{
  metrics: %{
    scrolls: non_neg_integer(),
    predictions: non_neg_integer(),
    cache_hits: non_neg_integer(),
    cache_misses: non_neg_integer(),
    optimizations: non_neg_integer()
  },
  optimizer: Raxol.Terminal.Scroll.Optimizer.t(),
  predictor: Raxol.Terminal.Scroll.Predictor.t(),
  sync: Raxol.Terminal.Scroll.Sync.t()
}

Functions

clear_history(manager)

@spec clear_history(t()) :: {:ok, t()}

Clears the scroll history.

get_history(manager, opts \\ [])

@spec get_history(
  t(),
  keyword()
) :: {:ok, [map()], t()}

Gets the scroll history.

Parameters

manager - The scroll manager
opts - History options
- :limit - Maximum number of entries to return (default: all)
- :direction - Filter by direction (:up or :down)

get_metrics(manager)

@spec get_metrics(t()) :: map()

Gets the current scroll metrics.

new(opts \\ [])

@spec new(keyword()) :: t()

Creates a new scroll manager.

Options

:prediction_enabled - Whether to enable predictive scrolling (default: true)
:optimization_enabled - Whether to enable scroll optimization (default: true)
:sync_enabled - Whether to enable scroll synchronization (default: true)

optimize(manager)

@spec optimize(t()) :: t()

Optimizes the scroll manager based on current metrics.

scroll(manager, direction, amount, opts \\ [])

@spec scroll(t(), :up | :down, non_neg_integer(), keyword()) ::
  {:ok, t()} | {:error, term()}

Scrolls the terminal content.

Parameters

manager - The scroll manager
direction - Scroll direction (:up or :down)
lines - Number of lines to scroll
opts - Scroll options
- :predict - Whether to use prediction (default: true)
- :optimize - Whether to optimize the scroll (default: true)
- :sync - Whether to sync across splits (default: true)