package zarr

You can search for identifiers within the package.

in-package search v0.2.0

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Metadata.GroupMetadata`Source

A module which contains functionality to work with a parsed JSON Zarr group metadata document.

Sourcetype t

A type representing a parsed group metadata document.

Sourceval default : t

Return a group metadata type with default values for all fields.

Sourceval encode : t -> string

encode t returns a byte string representing a JSON Zarr group metadata.

Sourceval decode : string -> t

decode s decodes a bytes string s into a t type.

Sourceval update_attributes : t -> Yojson.Safe.t -> t

update_attributes t json returns a new metadata type with an updated attribute field containing contents in json.

Sourceval show : t -> string

show t pretty-prints the contents of the group metadata type t.

Sourceval attributes : t -> Yojson.Safe.t

attributes t Returns a Yojson type containing user attributes assigned to the zarr group represented by t.