Store Class

Class representing an abstract store

Details

Abstract store for Zarr

Public fields

metadata_class

TODO

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$get_consolidated_metadata()

• Store$clone()

---

Method new()

Create a Store object

Usage

Store$new()

---

Method is_readable()

test if Store is readable

Usage

Store$is_readable()

---

Method is_writeable()

test if Store is writeable

Usage

Store$is_writeable()

---

Method is_erasable()

test if Store is eraseable

Usage

Store$is_erasable()

---

Method is_listable()

test if Store is listable

Usage

Store$is_listable()

---

Method close()

close the store

Usage

Store$close()

---

Method listdir()

list the store directory

Usage

Store$listdir(path = NA)

Arguments

path

character path

---

Method rename()

rename a Store

Usage

Store$rename(src_path, dst_path)

Arguments

src_path

character source path

dst_path

character destination path

---

Method rmdir()

remove a path within a Store

Usage

Store$rmdir(path)

Arguments

path

character path

---

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.

---

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 get_consolidated_metadata()

Get consolidated metadata if it exists.

Usage

Store$get_consolidated_metadata()

---

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.