R/generics_reset.R

In LLMR: Interface for Large Language Model APIs in R

# generics_reset.R --------------------------------------------------------------
# A shared S3 generic for resetting a stateful LLMR-family object to its initial
# position (for example, an archive replayer whose queue has advanced). LLMR
# defines the generic and an erroring default only; method packages register
# class-specific methods. Additive: no existing LLMR behavior changes.

#' Reset a stateful object to its initial position
#'
#' 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.
#'
#' @param x An object with resettable state.
#' @param ... Passed to methods.
#' @return `x`, invisibly, with its state restored.
#' @examples
#' \dontrun{
#' # An archive replayer whose queue has advanced can be rewound:
#' reset(replayer)
#' }
#' @export
reset <- function(x, ...) {
  UseMethod("reset")
}

#' @export
reset.default <- function(x, ...) {
  cls <- class(x)
  if (!length(cls)) cls <- typeof(x)
  .llmr_error(
    message = sprintf(
      "No reset() method for objects of class <%s>; this generic is implemented by the LLMR method packages.",
      paste(cls, collapse = ", ")
    ),
    category = "param"
  )
}