Store Class

Class representing an abstract store

Format

R6::R6Class

Details

Abstract store for Zarr

See also

Other Store classes: DirectoryStore, HttpStore, MemoryStore

Public fields

metadata_class

The metadata encoder/decoder for this store.

Methods

Public methods

• Store$new()

• Store$is_readable()

• Store$is_writeable()

• Store$is_erasable()

• Store$is_listable()

• Store$close()

• Store$listdir()

• Store$rename()

• Store$rmdir()

• Store$get_item()

• Store$set_item()

• Store$contains_item()

• Store$delete_item()

• Store$get_consolidated_metadata()

• Store$print()

• Store$clone()

---

Method new()

Create a Store object

Usage

Store$new()

---

Method is_readable()

Test if Store is readable.

Usage

Store$is_readable()

Returns

Logical.

---

Method is_writeable()

Test if Store is writeable.

Usage

Store$is_writeable()

Returns

Logical.

---

Method is_erasable()

Test if Store is eraseable.

Usage

Store$is_erasable()

Returns

Logical.

---

Method is_listable()

Test if Store is listable.

Usage

Store$is_listable()

Returns

Logical.

---

Method close()

Close the store.

Usage

Store$close()

Returns

NULL.

---

Method listdir()

List the store directory.

Usage

Store$listdir(path = NA)

Arguments

path

character path.

Returns

Character vector of keys.

---

Method rename()

Rename a Store path.

Usage

Store$rename(src_path, dst_path)

Arguments

src_path

character source path.

dst_path

character destination path.

Returns

NULL (called for side effects).

---

Method rmdir()

Remove a path within a Store.

Usage

Store$rmdir(path)

Arguments

path

character path.

Returns

NULL (called for side effects).

---

Method get_item()

Get an item from the store.

Usage

Store$get_item(key)

Arguments

key

The item key.

Returns

The item data in a vector of type raw.

---

Method set_item()

Set an item in the store.

Usage

Store$set_item(key, value)

Arguments

key

The item key.

value

The item value as a vector of type raw.

Returns

NULL (called for side effects).

---

Method contains_item()

Determine whether the store contains an item.

Usage

Store$contains_item(key)

Arguments

key

The item key.

Returns

A boolean value.

---

Method delete_item()

Delete an item from the store.

Usage

Store$delete_item(key)

Arguments

key

The item key.

Returns

NULL (called for side effects).

---

Method get_consolidated_metadata()

Get consolidated metadata if it exists.

Usage

Store$get_consolidated_metadata()

Returns

A list or NULL.

---

Method print()

Print a human-readable summary of the store.

Usage

Store$print(...)

Arguments

...

Ignored.

Returns

self (invisibly).

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Store$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.