Struct NodeName 

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

A Zarr hierarchy node name.

See

• https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html#name, and
• https://zarr-specs.readthedocs.io/en/latest/v3/core/index.html#node-names.

Implementations

impl NodeName

pub fn new(name: impl Into<String>) -> Result<Self, NodeNameError>

Create a new Zarr node name from name.

Errors

Returns NodeNameError if name is not valid according to NodeName::validate().

pub unsafe fn new_unchecked(name: impl Into<String>) -> Self

Create a new Zarr node name from name.

Safety

name is not validated, so this can result in an invalid node name.

pub const fn root() -> Self

The root node.

pub fn as_str(&self) -> &str

Extracts a string slice containing the node name String.

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

Validates a node name according to the following rules from the specification:

• The root node does not have a name and is the empty string “”.

Otherwise,

• must not be the empty string (“”),
• must not include the character “/”,
• must not be a string composed only of period characters, e.g. “.” or “..”, and
• must not start with the reserved prefix “__”.

pub fn is_root(&self) -> bool

Indicates if a node has the root node name (“”).

Trait Implementations

impl Debug for NodeName

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

Formats the value using the given formatter.

impl Display for NodeName

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

Formats the value using the given formatter.

impl PartialEq for NodeName

fn eq(&self, other: &NodeName) -> 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 Eq for NodeName

impl StructuralPartialEq for NodeName