storage.init.default: Initialize a memory store.

In memofunc: Function Memoization

Description

Initlaize memory storage, used to hold and retrieve values in memory.

The storage type is expected to specified as memory.

This storage is transient.

Usage

## Default S3 method:
storage.init(storage.type, ...)

Arguments

storage.type	storage type to initialize, defaults to memory
...	additional configuration values used by storage implementations

Value

List containing characteristics perticular to the storage implementation, including:

• $type - the storage type

Examples

library(magrittr)

# initialize default memory storage
my.storage <- storage.init()

# set a value into storage
storage.set(my.storage, "name", "Roy Wetherall")

# .. and some more
my.storage %>% 
  storage.set("age", 45) %>% 
  storage.set("alive", TRUE) %>%
  storage.set("children", c("Peter", "Grace", "Lucy"))

# check a key has been set
if (storage.has(my.storage, "name")) print("I know your name!")

# .. and that a key hasn't been set
if (!storage.has(my.storage, "address")) print("I don't know where you live!")

# get some values from storage
sprintf(
  "%s is %i years old.", 
  storage.get(my.storage, "name"),
  storage.get(my.storage, "age"))

# remove a value from storage
storage.unset(my.storage, "children")

# .. and show it's not there anymore
if (!storage.has(my.storage, "address")) print("I don't know who your children are!")

# clear all values from storage
storage.clear(my.storage)

# .. and everything is gone
if (!storage.has(my.storage, "name") && !storage.has(my.storage, "age")) print("I know nothing!")

memofunc documentation built on Feb. 23, 2021, 1:06 a.m.