[−][src]Trait n5::N5Reader

pub trait N5Reader {
    fn get_version(&self) -> Result<Version, Error>;

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

    fn exists(&self, path_name: &str) -> Result<bool, Error>;

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

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

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

    fn block_metadata(
        &self, 
        path_name: &str, 
        data_attrs: &DatasetAttributes, 
        grid_position: &[u64]
    ) -> Result<Option<DataBlockMetadata>, Error>;

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

    fn dataset_exists(&self, path_name: &str) -> Result<bool, Error> { ... }
}

Non-mutating operations on N5 containers.

Required methods

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

Get the N5 specification version of the container.

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

Get attributes for a dataset.

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

Test whether a group or dataset exists.

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

Get a URI string for a data block.

Whether this requires that the dataset and block exist is currently implementation dependent. Whether this URI is a URL is implementation dependent.

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

Read a single dataset block into a linear vec.

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

Read a single dataset block into an existing buffer.

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

Read metadata about a block.

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

List all attributes of a group.

Loading content...

Provided methods

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

Test whether a dataset exists.

Loading content...

Implementors

impl N5Reader for N5Filesystem[src]

Loading content...