reset: Reset a stateful object to its initial position

View source: R/generics_reset.R

resetR Documentation

Reset a stateful object to its initial position

Description

A shared generic across the LLMR method packages, for objects that carry consumable state. LLMR defines the generic and an erroring default only; a method package (for example, an archive replayer) registers the concrete method that restores its state.

Usage

reset(x, ...)

Arguments

x

An object with resettable state.

...

Passed to methods.

Value

x, invisibly, with its state restored.

Examples

## Not run: 
# An archive replayer whose queue has advanced can be rewound:
reset(replayer)

## End(Not run)

LLMR documentation built on July 11, 2026, 1:06 a.m.