Struct oceanpkg::drop::Name

pub struct Name(_);

A valid drop name.

Valid names are non-empty, lowercase ASCII alphanumeric, and can have dashes (-) anywhere except for the beginning or end.

Methods

impl Name

pub const CORE: &'static Self

The string "core".

pub const OCEAN: &'static Self

The string "ocean".

pub const SELF: &'static Self

The string "self".

pub const RESERVED_SCOPES: &'static [&'static Self]

Namespaces reserved to only be used only by Ocean.

pub fn new<'a, N>(name: N) -> Result<&'a Self, ValidateError> where
    N: TryInto<&'a Self, Error = ValidateError>, 

Attempts to create a new instance by parsing name.

pub unsafe fn new_unchecked<N: ?Sized>(name: &N) -> &Self where
    N: AsRef<[u8]>, 

Creates a new instance without parsing name.

pub fn is_valid<N: AsRef<[u8]>>(name: N) -> bool

Returns whether name is valid.

All characters in name must match the regex [0-9a-z-], with the exception of the first and last character where - is not allowed.

pub fn is_valid_ascii(byte: u8) -> bool

Returns whether byte is valid within a name.

Regex: [0-9a-z-].

Note that this returns true for - despite it being invalid at the start and end of a full name.

pub fn is_valid_char(ch: char) -> bool

Returns whether the unicode scalar is valid within a name.

See is_valid_ascii for more info.

pub const fn as_str(&self) -> &str

Converts self to the underlying UTF-8 string slice.

pub fn into_boxed(&self) -> Box<Self>

Moves copied contents of self to the heap.

pub fn is_reserved_scope(&self) -> bool

Returns whether Ocean reserves the right to use this name as a scope.

Trait Implementations

impl AsRef<[u8]> for Name

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl AsRef<str> for Name

fn as_ref(&self) -> &str

Performs the conversion.

impl Debug for Name

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for &'a Name

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Name

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

Formats the value using the given formatter.

impl Eq for Name

impl<'_> From<&'_ Name> for Box<Name>

fn from(name: &Name) -> Self

Performs the conversion.

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Name

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<[u8]> for Name

fn eq(&self, b: &[u8]) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Name> for Name

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<Name> for str

fn eq(&self, n: &Name) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Name> for [u8]

fn eq(&self, n: &Name) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<str> for Name

fn eq(&self, s: &str) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Name> for Name

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Name

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralEq for Name

impl StructuralPartialEq for Name

impl<'a> TryFrom<&'a [u8]> for &'a Name

type Error = ValidateError

The type returned in the event of a conversion error.

fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a CStr> for &'a Name

type Error = ValidateError

The type returned in the event of a conversion error.

fn try_from(s: &'a CStr) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a OsStr> for &'a Name

type Error = ValidateError

The type returned in the event of a conversion error.

fn try_from(s: &'a OsStr) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for &'a Name

type Error = ValidateError

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.