Struct secret_tree::Name

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

Name of a child SecretTree.

Used in SecretTree::child(); see its documentation for more context.

An original str can be extracted from Name using AsRef / Display implementations:

const NAME: Name = Name::new("test_name");
assert_eq!(NAME.as_ref(), "test_name");
assert_eq!(NAME.to_string(), "test_name");

Implementations

impl Name

pub const fn new(name: &str) -> Self

Creates a new Name.

The supplied string must be no more than MAX_NAME_LEN bytes in length and must not contain null chars '\0'.

This is a constant method, which perform all relevant checks during compilation in a constant context:

const NAME: Name = Name::new("some_name");

For example, this won’t compile since the name is too long (17 chars):

const OVERLY_LONG_NAME: Name = Name::new("Overly long name!");

…And this won’t compile because the name contains a \0 char:

const NAME_WITH_ZERO_CHARS: Name = Name::new("12\03");

Panics

Panics if name is overly long or contains null chars. Use the FromStr implementation for a fallible / non-panicking alternative.

Trait Implementations

impl AsRef<str> for Name

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Name

fn clone(&self) -> Name

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl Display for Name

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

Formats the value using the given formatter.

impl FromStr for Name

type Err = NameError

The associated error which can be returned from parsing.

fn from_str(name: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Name

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 PartialEq for Name

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

impl Eq for Name

impl StructuralPartialEq for Name