Struct SymbolName 

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

A validated symbol or container name: surrounding whitespace trimmed, non-blank and bounded.

Examples

use mcpls_core::bridge::SymbolName;

assert_eq!(SymbolName::new("parse_config").unwrap().as_str(), "parse_config");
assert_eq!(SymbolName::new(" parse_config ").unwrap().as_str(), "parse_config");
assert!(SymbolName::new("  ").is_err());

Implementations

impl SymbolName

pub fn new(raw: impl Into<String>) -> Result<Self, InvalidBoundedText>

Validate raw after trimming surrounding whitespace, which is not part of the name.

Errors

InvalidBoundedText when the trimmed text is blank or longer than MAX_SYMBOL_NAME_BYTES.

impl SymbolName

pub fn as_str(&self) -> &str

The validated text.

Trait Implementations

impl AsRef<str> for SymbolName

fn as_ref(&self) -> &str

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

impl Borrow<str> for SymbolName

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for SymbolName

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolName

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

Formats the value using the given formatter.

impl Display for SymbolName

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

Formats the value using the given formatter.

impl Eq for SymbolName

impl From<SymbolName> for String

fn from(value: SymbolName) -> Self

Converts to this type from the input type.

impl FromStr for SymbolName

type Err = InvalidBoundedText

The associated error which can be returned from parsing.

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

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

impl PartialEq for SymbolName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for SymbolName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for SymbolName

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SymbolName

impl TryFrom<String> for SymbolName

type Error = InvalidBoundedText

The type returned in the event of a conversion error.

fn try_from(text: String) -> Result<Self, Self::Error>

Performs the conversion.