package zarr-eio

You can search for identifiers within the package.

in-package search v0.2.0

package zarr-eio

zarr-eio
- Zarr_eio
  - Deferred
    
    Infix
    
    Syntax
  - Storage
    
    FilesystemStore
    
    Deferred
    
    Infix
    
    Syntax
    
    MemoryStore
    
    Deferred
    
    Infix
    
    Syntax

Legend:
Library
Module
Module type
Parameter
Class
Class type

A local filesystem storage backend for a Zarr V3 hierarchy.

include Zarr.Storage.STORE with type 'a Deferred.t = 'a

module Deferred : sig ... end

type t

val create_group : 
  ?attrs:Yojson.Safe.t ->
  t ->
  Zarr__.Node.GroupNode.t ->
  unit Deferred.t

val create_array : 
  ?sep:[< `Dot | `Slash Slash ] ->
  ?dimension_names:string option list ->
  ?attributes:Yojson.Safe.t ->
  codecs:Zarr__.Codecs.codec_chain ->
  shape:int array ->
  chunks:int array ->
  'a Zarr__.Ndarray.dtype ->
  'a ->
  Zarr__.Node.ArrayNode.t ->
  t ->
  unit Deferred.t

val array_metadata : 
  t ->
  Zarr__.Node.ArrayNode.t ->
  Zarr__.Metadata.ArrayMetadata.t Deferred.t

val group_metadata : 
  t ->
  Zarr__.Node.GroupNode.t ->
  Zarr__.Metadata.GroupMetadata.t Deferred.t

val find_child_nodes : 
  t ->
  Zarr__.Node.GroupNode.t ->
  (Zarr__.Node.ArrayNode.t list * Zarr__.Node.GroupNode.t list) Deferred.t

val find_all_nodes : 
  t ->
  (Zarr__.Node.ArrayNode.t list * Zarr__.Node.GroupNode.t list) Deferred.t

val erase_group_node : t -> Zarr__.Node.GroupNode.t -> unit Deferred.t

val erase_array_node : t -> Zarr__.Node.ArrayNode.t -> unit Deferred.t

val erase_all_nodes : t -> unit Deferred.t

val group_exists : t -> Zarr__.Node.GroupNode.t -> bool Deferred.t

val array_exists : t -> Zarr__.Node.ArrayNode.t -> bool Deferred.t

val write_array : 
  t ->
  Zarr__.Node.ArrayNode.t ->
  Zarr__.Ndarray.Indexing.index array ->
  'a Zarr__.Ndarray.t ->
  unit Deferred.t

val read_array : 
  t ->
  Zarr__.Node.ArrayNode.t ->
  Zarr__.Ndarray.Indexing.index array ->
  'a Zarr__.Ndarray.dtype ->
  'a Zarr__.Ndarray.t Deferred.t

val reshape : t -> Zarr__.Node.ArrayNode.t -> int array -> unit Deferred.t

val create : 
  ?perm:Eio.File.Unix_perm.t ->
  env:< fs : Eio.Fs.dir_ty Eio.Path.t.. > ->
  string ->
  t

create ~perm ~env dir returns a new filesystem store.

raises Failure
if dir is a directory that already exists.

val open_store : 
  ?perm:Eio.File.Unix_perm.t ->
  env:< fs : Eio.Fs.dir_ty Eio.Path.t.. > ->
  string ->
  t

open_store ~perm ~env dir returns an existing filesystem Zarr store.

raises Failure
if dir is a file and not a Zarr store path.