Struct IdentStr 

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

A borrowed identifier.

For more details, see the module level documentation.

Implementations

impl IdentStr

pub fn new(s: &str) -> Result<&IdentStr, InvalidIdentifierError>

pub const fn cast(s: &'static str) -> &'static IdentStr

Compile-time validated constructor from static string slice.

Example

Creating a valid static or const IdentStr:

use af_sui_types::IdentStr;
const VALID_IDENT: &'static IdentStr = IdentStr::cast("MyCoolIdentifier");

const THING_NAME: &'static str = "thing_name";
const THING_IDENT: &'static IdentStr = IdentStr::cast(THING_NAME);

In contrast, creating an invalid IdentStr will fail at compile time:

use af_sui_types::IdentStr;
const INVALID_IDENT: &'static IdentStr = IdentStr::cast("123Foo"); // Fails to compile!

pub fn is_valid(s: impl AsRef<str>) -> bool

Returns true if this string is a valid identifier.

pub const fn len(&self) -> usize

Returns the length of self in bytes.

pub const fn is_empty(&self) -> bool

Returns true if self has a length of zero bytes.

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

Converts self to a &str.

This is not implemented as a From trait to discourage automatic conversions – these conversions should not typically happen.

pub const fn as_bytes(&self) -> &[u8]

Converts self to a byte slice.

Trait Implementations

impl Borrow<IdentStr> for Identifier

fn borrow(&self) -> &IdentStr

Immutably borrows from an owned value.

impl Debug for IdentStr

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

Formats the value using the given formatter.

impl Display for IdentStr

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

Formats the value using the given formatter.

impl Eq for IdentStr

impl Hash for IdentStr

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

Feeds this value into the given Hasher.

impl Ord for IdentStr

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

This method returns an Ordering between self and other.

impl PartialEq for IdentStr

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for IdentStr

fn partial_cmp(&self, other: &IdentStr) -> 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 RefCast for IdentStr

type From = str

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self

impl StructuralPartialEq for IdentStr

impl ToOwned for IdentStr

type Owned = Identifier

The resulting type after obtaining ownership.

fn to_owned(&self) -> Identifier

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.