Struct n5::filesystem::N5Filesystem

pub struct N5Filesystem { /* fields omitted */ }

A filesystem-backed N5 container.

Methods

impl N5Filesystem

pub fn open(base_path: &str) -> Result<N5Filesystem>

Open an existing N5 container by path.

pub fn open_or_create(base_path: &str) -> Result<N5Filesystem>

Open an existing N5 container by path or create one if none exists.

Note this will update the version attribute for existing containers.

pub fn get_attributes(&self, path_name: &str) -> Result<Value>

Trait Implementations

impl N5Reader for N5Filesystem

fn get_version(&self) -> Result<Version>

Get the N5 specification version of the container.

fn get_dataset_attributes(&self, path_name: &str) -> Result<DatasetAttributes>

Get attributes for a dataset.

fn exists(&self, path_name: &str) -> bool

Test whether a group or dataset exists.

fn get_block_uri(
    &self,
    path_name: &str,
    grid_position: &[i64]
) -> Result<String>

Get a URI string for a data block.

fn read_block<T>(
    &self,
    path_name: &str,
    data_attrs: &DatasetAttributes,
    grid_position: GridCoord
) -> Result<Option<VecDataBlock<T>>> where
    VecDataBlock<T>: DataBlock<T>,
    T: ReflectedType, 

Read a single dataset block into a linear vec.

fn read_block_into<T: ReflectedType, B: DataBlock<T>>(
    &self,
    path_name: &str,
    data_attrs: &DatasetAttributes,
    grid_position: GridCoord,
    block: &mut B
) -> Result<Option<()>>

Read a single dataset block into an existing buffer.

fn block_metadata(
    &self,
    path_name: &str,
    _data_attrs: &DatasetAttributes,
    grid_position: &[i64]
) -> Result<Option<DataBlockMetadata>>

Read metadata about a block.

fn list(&self, path_name: &str) -> Result<Vec<String>>

List all groups (including datasets) in a group.

fn list_attributes(&self, path_name: &str) -> Result<Value>

List all attributes of a group.

fn dataset_exists(&self, path_name: &str) -> bool

Test whether a dataset exists.

impl N5Writer for N5Filesystem

fn set_attributes(
    &self,
    path_name: &str,
    attributes: Map<String, Value>
) -> Result<()>

Set a map of attributes.

fn create_group(&self, path_name: &str) -> Result<()>

Create a group (directory).

fn remove(&self, path_name: &str) -> Result<()>

Remove a group or dataset (directory and all contained files).

fn write_block<T, B: DataBlock<T>>(
    &self,
    path_name: &str,
    data_attrs: &DatasetAttributes,
    block: &B
) -> Result<()>

fn set_attribute<T: Serialize>(
    &self,
    path_name: &str,
    key: String,
    attribute: T
) -> Result<(), Error>

Set a single attribute.

fn set_dataset_attributes(
    &self,
    path_name: &str,
    data_attrs: &DatasetAttributes
) -> Result<(), Error>

Set mandatory dataset attributes.

fn create_dataset(
    &self,
    path_name: &str,
    data_attrs: &DatasetAttributes
) -> Result<(), Error>

Create a dataset. This will create the dataset group and attributes, but not populate any block data.

fn remove_all(&self) -> Result<(), Error>

Remove the N5 container.

impl Clone for N5Filesystem

fn clone(&self) -> N5Filesystem

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.