R/cache_register_sodium.R

In decisionpatterns/cache.sodium: Sodium Extension to 'cache' Package

#' Register sodium as a backend for cache
#'
#' Installs `cache.sodium` for use as an extension for writing/reading files
#'
#' @details
#'
#' You probably should use [cache_use_sodium()] instead which makes sodium
#' the default method for reading/writing to the cache.  There is generally no
#' reason to invoke this function as it is called when the packages is
#' attached.
#'
#' @note
#' The call to `cache_register_backend` can be placed in `zzz.R` and not
#' exist as a separate function.
#'
#' @seealso
#'  - [cache_use_sodium()]
#'
#' @import cache
# @export

cache_register_sodium <- function() {

  if( interactive() ) {
    message( "Registering 'cache.sodium' as a cache backend." )
    message( "  Use 'cache_use_sodium(...)' to set it as the default." )
  }

  cache::cache_backend_register(
      name = 'sodium'
    , ext = EXTENSION
    , pkg = PKG
    , reader = sodium_read
    , writer = sodium_write
  )

}