Struct crackle_lib::RoomName

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

The name of a room.

It can’t exceed 255 bytes or be empty.

Implementations

impl RoomName

pub fn as_str(&self) -> &str

Creates a string slice from this RoomName.

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

Creates a byte slice from this RoomName.

impl RoomName

pub fn parse(s: impl AsRef<str>) -> Result<OwnedRoomName, Error>

Try parsing a &str into an OwnedRoomName.

The same can also be done using FromStr, TryFrom or TryInto. This function is simply more constrained and thus useful in generic contexts.

pub fn parse_box(
    s: impl AsRef<str> + Into<Box<str, Global>>
) -> Result<Box<RoomName, Global>, Error>

Try parsing a &str into a Box<RoomName>.

The same can also be done using FromStr, TryFrom or TryInto. This function is simply more constrained and thus useful in generic contexts.

pub fn parse_rc(
    s: impl AsRef<str> + Into<Rc<str>>
) -> Result<Rc<RoomName>, Error>

Try parsing a &str into an Rc<RoomName>.

pub fn parse_arc(
    s: impl AsRef<str> + Into<Arc<str>>
) -> Result<Arc<RoomName>, Error>

Try parsing a &str into an Arc<RoomName>.

Trait Implementations

impl AsRef<RoomName> for OwnedRoomName

fn as_ref(&self) -> &RoomName

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

impl AsRef<str> for RoomName

fn as_ref(&self) -> &str

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

impl Borrow<RoomName> for OwnedRoomName

fn borrow(&self) -> &RoomName

Immutably borrows from an owned value.

impl Debug for RoomName

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

Formats the value using the given formatter.

impl Display for RoomName

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

Formats the value using the given formatter.

impl<'_> From<&'_ RoomName> for OwnedRoomName

fn from(id: &RoomName) -> OwnedRoomName

Converts to this type from the input type.

impl Hash for RoomName

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

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 RoomName

fn cmp(&self, other: &RoomName) -> 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

Restrict a value to a certain interval.

impl<'_> PartialEq<&'_ RoomName> for OwnedRoomName

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

impl<'_> PartialEq<Box<RoomName, Global>> for &'_ RoomName

fn eq(&self, other: &Box<RoomName, Global>) -> bool

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

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

This method tests for !=.

impl PartialEq<Box<RoomName, Global>> for RoomName

fn eq(&self, other: &Box<RoomName, Global>) -> bool

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

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

This method tests for !=.

impl PartialEq<OwnedRoomName> for RoomName

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

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

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

This method tests for !=.

impl<'_> PartialEq<OwnedRoomName> for &'_ RoomName

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

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

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

This method tests for !=.

impl PartialEq<RoomName> for OwnedRoomName

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

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

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

This method tests for !=.

impl PartialEq<RoomName> for RoomName

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

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

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

This method tests for !=.

impl PartialEq<RoomName> for str

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

impl PartialEq<String> for RoomName

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

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

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

This method tests for !=.

impl PartialEq<str> for RoomName

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

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

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

This method tests for !=.

impl PartialOrd<RoomName> for RoomName

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

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

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

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

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

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

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

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

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 Serialize for RoomName

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

Serialize this value into the given Serde serializer.

impl ToOwned for RoomName

type Owned = OwnedRoomName

The resulting type after obtaining ownership.

fn to_owned(&self) -> <RoomName as ToOwned>::Owned

Creates owned data from borrowed data, usually by cloning.

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

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

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

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for RoomName

impl StructuralEq for RoomName

impl StructuralPartialEq for RoomName