Struct NodePath 

pub struct NodePath(/* private fields */);

A Zarr hierarchy node path.

See https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html#path

Implementations

impl NodePath

pub fn new(path: &str) -> Result<Self, NodePathError>

Create a new Zarr node path from path.

Errors

Returns NodePathError if path is not valid according to NodePath::validate().

pub fn root() -> Self

The root node.

pub fn as_str(&self) -> &str

Extracts a string slice containing the node path String.

pub fn as_path(&self) -> &Path

Extracts the path as a std::path::Path.

pub fn validate(path: &str) -> bool

Validates a path according to the following rules from the specification:

• A path always starts with /, and
• a non-root path cannot end with /, because node names must be non-empty and cannot contain /.

Additionally, it checks that there are no empty nodes (i.e. a // substring).

Trait Implementations

impl Clone for NodePath

fn clone(&self) -> NodePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodePath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for NodePath

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Node> for NodePath

fn from(value: Node) -> Self

Converts to this type from the input type.

impl Hash for NodePath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for NodePath

fn cmp(&self, other: &NodePath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for NodePath

fn eq(&self, other: &NodePath) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for NodePath

fn partial_cmp(&self, other: &NodePath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&StorePrefix> for NodePath

type Error = NodePathError

The type returned in the event of a conversion error.

fn try_from(prefix: &StorePrefix) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for NodePath

type Error = NodePathError

The type returned in the event of a conversion error.

fn try_from(path: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryInto<StorePrefix> for &NodePath

type Error = StorePrefixError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<StorePrefix, StorePrefixError>

Performs the conversion.

impl Eq for NodePath

impl StructuralPartialEq for NodePath