Class representing an abstract store
Details
Abstract store for Zarr
Public fields
metadata_class
The metadata encoder/decoder for this store.
Methods
Store$new()
Create a Store object
Store$is_readable()
Test if Store is readable.
Store$is_writeable()
Test if Store is writeable.
Store$is_erasable()
Test if Store is eraseable.
Store$is_listable()
Test if Store is listable.
Store$close()
Close the store.
Store$listdir()
List the store directory.
Returns
Character vector of keys.
Store$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).
Store$rmdir()
Remove a path within a Store.
Returns
NULL (called for side effects).
Store$get_item()
Get an item from the store.
Returns
The item data in a vector of type raw.
Store$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).
Store$contains_item()
Determine whether the store contains an item.
Store$delete_item()
Delete an item from the store.
Returns
NULL (called for side effects).
Get consolidated metadata if it exists.
Usage
Store$get_consolidated_metadata()
Store$get_store_identifier()
Return a store identifier for zarrs dispatch.
Subclasses override this to return a filesystem path or URL.
Returns NULL by default (signals: use R-native path).
Usage
Store$get_store_identifier()
Returns
A character string or NULL.
Store$print()
Print a human-readable summary of the store.
Returns
self (invisibly).
Store$clone()
The objects of this class are cloneable with this method.
Usage
Store$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.