Struct GameProfileString 

pub struct GameProfileString<const MAX_UTF16_CODE_UNITS: usize>(/* private fields */);

A protocol string with a game-profile-specific UTF-16 length limit.

Use the aliases GameProfileUsername, GameProfilePropertyName, GameProfilePropertyValue, and GameProfilePropertySignature rather than spelling the const generic directly.

Implementations

impl<const MAX_UTF16_CODE_UNITS: usize> GameProfileString<MAX_UTF16_CODE_UNITS>

pub const MAX_UTF16_CODE_UNITS: usize = MAX_UTF16_CODE_UNITS

Maximum number of UTF-16 code units accepted by this string type.

pub const MAX_BYTES: usize

Maximum UTF-8 payload size accepted by this string type.

pub fn new(value: impl Into<String>) -> Result<Self, GameProfileStringTooLong>

Creates a string after checking its UTF-16 code-unit limit.

pub fn as_str(&self) -> &str

Returns the string value.

pub fn into_inner(self) -> String

Extracts the owned string.

Trait Implementations

impl<const MAX_UTF16_CODE_UNITS: usize> AsRef<str> for GameProfileString<MAX_UTF16_CODE_UNITS>

fn as_ref(&self) -> &str

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

impl<const MAX_UTF16_CODE_UNITS: usize> Clone for GameProfileString<MAX_UTF16_CODE_UNITS>

fn clone(&self) -> GameProfileString<MAX_UTF16_CODE_UNITS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MAX_UTF16_CODE_UNITS: usize> Debug for GameProfileString<MAX_UTF16_CODE_UNITS>

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

Formats the value using the given formatter.

impl<const MAX_UTF16_CODE_UNITS: usize> Default for GameProfileString<MAX_UTF16_CODE_UNITS>

fn default() -> GameProfileString<MAX_UTF16_CODE_UNITS>

Returns the “default value” for a type.

impl<const MAX_UTF16_CODE_UNITS: usize> Display for GameProfileString<MAX_UTF16_CODE_UNITS>

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

Formats the value using the given formatter.

impl<const MAX_UTF16_CODE_UNITS: usize> Eq for GameProfileString<MAX_UTF16_CODE_UNITS>

impl<const MAX_UTF16_CODE_UNITS: usize> From<GameProfileString<MAX_UTF16_CODE_UNITS>> for String

fn from(value: GameProfileString<MAX_UTF16_CODE_UNITS>) -> Self

Converts to this type from the input type.

impl<const MAX_UTF16_CODE_UNITS: usize> Hash for GameProfileString<MAX_UTF16_CODE_UNITS>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const MAX_UTF16_CODE_UNITS: usize> PartialEq for GameProfileString<MAX_UTF16_CODE_UNITS>

fn eq(&self, other: &GameProfileString<MAX_UTF16_CODE_UNITS>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<const MAX_UTF16_CODE_UNITS: usize> StructuralPartialEq for GameProfileString<MAX_UTF16_CODE_UNITS>

impl<const MAX_UTF16_CODE_UNITS: usize> TryFrom<&str> for GameProfileString<MAX_UTF16_CODE_UNITS>

type Error = GameProfileStringTooLong

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl<const MAX_UTF16_CODE_UNITS: usize> TryFrom<String> for GameProfileString<MAX_UTF16_CODE_UNITS>

type Error = GameProfileStringTooLong

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const MAX_UTF16_CODE_UNITS: usize> TypeCodec for GameProfileString<MAX_UTF16_CODE_UNITS>

fn encode(&self, writer: &mut impl Write) -> Result<(), CodecError>

Encodes this value to the writer.

fn decode(reader: &mut impl Read) -> Result<Self, CodecError>

Decodes this value from the reader.