DirectoryStore Class

Store class using directories and files on a standard file system.

Details

DirectoryStore for Zarr

Super class

pizzarr::Store -> DirectoryStore

Public fields

root

The path to the root of the store.

Methods

Public methods

• DirectoryStore$new()

• DirectoryStore$get_item()

• DirectoryStore$set_item()

• DirectoryStore$contains_item()

• DirectoryStore$rmdir()

• DirectoryStore$listdir()

• DirectoryStore$clone()

Inherited methods

• pizzarr::Store$close()
• pizzarr::Store$get_consolidated_metadata()
• pizzarr::Store$is_erasable()
• pizzarr::Store$is_listable()
• pizzarr::Store$is_readable()
• pizzarr::Store$is_writeable()
• pizzarr::Store$rename()

---

Method new()

Create a new file system store.

Usage

DirectoryStore$new(root)

Arguments

root

The path to the root of the store.

Returns

A new DirectoryStore object.

---

Method get_item()

Get an item from the store.

Usage

DirectoryStore$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

DirectoryStore$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

DirectoryStore$contains_item(key)

Arguments

key

The item key.

Returns

A boolean value.

---

Method rmdir()

remove a path within a Store

Usage

DirectoryStore$rmdir(path = NA)

Arguments

path

character path

---

Method listdir()

list the store directory

Usage

DirectoryStore$listdir(key = NA)

Arguments

key

character key

---

Method clone()

The objects of this class are cloneable with this method.

Usage

DirectoryStore$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.