Struct xml_string::names::Ncname

#[repr(transparent)]pub struct Ncname(_);

String slice for NCName.

Implementations

impl Ncname

pub fn from_str(s: &str) -> Result<&Self, NameError>

Creates a new &Ncname.

Failures

Fails if the given string is not a valid NCName.

Examples

let name = Ncname::from_str("hello")?;
assert_eq!(name, "hello");

assert!(Ncname::from_str("").is_err(), "Empty string is not an NCName");
assert!(Ncname::from_str("foo bar").is_err(), "Whitespace is not allowed");
assert!(Ncname::from_str("foo:bar").is_err(), "Colon is not allowed");
assert!(Ncname::from_str("0foo").is_err(), "ASCII digit at the beginning is not allowed");

#[must_use]pub unsafe fn new_unchecked(s: &str) -> &Self

Creates a new &Ncname without validation.

Safety

The given string should be a valid NCName.

Examples

let name = unsafe {
    Ncname::new_unchecked("hello")
};
assert_eq!(name, "hello");

#[must_use]pub fn as_str(&self) -> &str

Returns the string as &str.

Examples

let name = Ncname::from_str("hello")?;
assert_eq!(name, "hello");

let s: &str = name.as_str();
assert_eq!(s, "hello");

pub fn parse_next(s: &str) -> Result<(&Self, &str), NameError>

Parses the leading Ncname and returns the value and the rest input.

Exmaples

let input = "hello:world";
let expected = Ncname::from_str("hello").expect("valid NCName");
assert_eq!(
    Ncname::parse_next(input),
    Ok((expected, ":world"))
);

let input = "012";
assert!(Ncname::parse_next(input).is_err());

pub fn into_boxed_str(self: Box<Self>) -> Box<str>

Converts a Box<Ncname> into a Box<str> without copying or allocating.

Examples

let name = Ncname::from_str("ncname")?;
let boxed_name: Box<Ncname> = name.into();
assert_eq!(&*boxed_name, name);
let boxed_str: Box<str> = boxed_name.into_boxed_str();
assert_eq!(&*boxed_str, name.as_str());

Trait Implementations

impl AsRef<Name> for Ncname

pub fn as_ref(&self) -> &Name

Performs the conversion.

impl AsRef<Ncname> for Ncname

pub fn as_ref(&self) -> &Ncname

Performs the conversion.

impl AsRef<Nmtoken> for Ncname

pub fn as_ref(&self) -> &Nmtoken

Performs the conversion.

impl AsRef<Qname> for Ncname

pub fn as_ref(&self) -> &Qname

Performs the conversion.

impl AsRef<str> for Ncname

pub fn as_ref(&self) -> &str

Performs the conversion.

impl<'_> Debug for &'_ Ncname

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

Formats the value using the given formatter.

impl<'_> Display for &'_ Ncname

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

Formats the value using the given formatter.

impl Eq for Ncname

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

pub fn from(s: &Ncname) -> Self

Performs the conversion.

impl<'_> From<&'_ Ncname> for Rc<Ncname>

pub fn from(s: &Ncname) -> Self

Performs the conversion.

impl<'_> From<&'_ Ncname> for Arc<Ncname>

pub fn from(s: &Ncname) -> Self

Performs the conversion.

impl<'a> From<&'a Ncname> for &'a Name

pub fn from(s: &'a Ncname) -> Self

Performs the conversion.

impl<'a> From<&'a Ncname> for &'a Nmtoken

pub fn from(s: &'a Ncname) -> Self

Performs the conversion.

impl<'a> From<&'a Ncname> for &'a Qname

pub fn from(s: &'a Ncname) -> Self

Performs the conversion.

impl Hash for Ncname

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

Feeds this value into the given Hasher.

pub 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 Ncname

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'_> PartialEq<&'_ Ncname> for str

pub fn eq(&self, o: &&Ncname) -> bool

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

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

This method tests for !=.

impl<'_> PartialEq<&'_ String> for Ncname

pub fn eq(&self, o: &&String) -> bool

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

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

This method tests for !=.

impl<'_> PartialEq<&'_ str> for Ncname

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

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

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

This method tests for !=.

impl PartialEq<Box<str, Global>> for Ncname

pub fn eq(&self, o: &Box<str>) -> bool

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

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

This method tests for !=.

impl<'_> PartialEq<Cow<'_, str>> for Ncname

pub fn eq(&self, o: &Cow<'_, str>) -> bool

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

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

This method tests for !=.

impl PartialEq<Ncname> for Ncname

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

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

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

This method tests for !=.

impl PartialEq<Ncname> for str

pub fn eq(&self, o: &Ncname) -> bool

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

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

This method tests for !=.

impl<'_> PartialEq<Ncname> for &'_ str

pub fn eq(&self, o: &Ncname) -> bool

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

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

This method tests for !=.

impl PartialEq<Ncname> for String

pub fn eq(&self, o: &Ncname) -> bool

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

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

This method tests for !=.

impl<'_> PartialEq<Ncname> for &'_ String

pub fn eq(&self, o: &Ncname) -> bool

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

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

This method tests for !=.

impl PartialEq<Ncname> for Box<str>

pub fn eq(&self, o: &Ncname) -> bool

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

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

This method tests for !=.

impl<'_> PartialEq<Ncname> for Cow<'_, str>

pub fn eq(&self, o: &Ncname) -> bool

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

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

This method tests for !=.

impl PartialEq<String> for Ncname

pub fn eq(&self, o: &String) -> bool

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

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

This method tests for !=.

impl PartialEq<str> for Ncname

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

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

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

This method tests for !=.

impl<'_> PartialEq<str> for &'_ Ncname

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

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

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

This method tests for !=.

impl<'_> PartialOrd<&'_ Ncname> for str

pub fn partial_cmp(&self, o: &&Ncname) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl<'_> PartialOrd<&'_ String> for Ncname

pub fn partial_cmp(&self, o: &&String) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl<'_> PartialOrd<&'_ str> for Ncname

pub fn partial_cmp(&self, o: &&str) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl PartialOrd<Box<str, Global>> for Ncname

pub fn partial_cmp(&self, o: &Box<str>) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl<'_> PartialOrd<Cow<'_, str>> for Ncname

pub fn partial_cmp(&self, o: &Cow<'_, str>) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl PartialOrd<Ncname> for Ncname

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<Ncname> for str

pub fn partial_cmp(&self, o: &Ncname) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl<'_> PartialOrd<Ncname> for &'_ str

pub fn partial_cmp(&self, o: &Ncname) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl PartialOrd<Ncname> for String

pub fn partial_cmp(&self, o: &Ncname) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl<'_> PartialOrd<Ncname> for &'_ String

pub fn partial_cmp(&self, o: &Ncname) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl PartialOrd<Ncname> for Box<str>

pub fn partial_cmp(&self, o: &Ncname) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl<'_> PartialOrd<Ncname> for Cow<'_, str>

pub fn partial_cmp(&self, o: &Ncname) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl PartialOrd<String> for Ncname

pub fn partial_cmp(&self, o: &String) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl PartialOrd<str> for Ncname

pub fn partial_cmp(&self, o: &str) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl<'_> PartialOrd<str> for &'_ Ncname

pub fn partial_cmp(&self, o: &str) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl StructuralEq for Ncname

impl StructuralPartialEq for Ncname

impl ToOwned for Ncname

type Owned = Box<Ncname>

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

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

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

recently added

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

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

type Error = NameError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<&'a Qname> for &'a Ncname

type Error = NameError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = NameError

The type returned in the event of a conversion error.

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

Performs the conversion.