Struct BoundedText 

pub struct BoundedText<const MAX: usize>(/* private fields */);

Non-blank text of at most MAX UTF-8 bytes.

Deserializes from a TOML string and rejects a blank or over-long value at load time. The cap counts bytes, not chars.

Examples

use mcpls_core::config::BoundedText;

let text = BoundedText::<8>::new("hello").unwrap();
assert_eq!(text.as_str(), "hello");
assert!(BoundedText::<8>::new("  ").is_err());
assert!(BoundedText::<8>::new("123456789").is_err());

Implementations

impl<const MAX: usize> BoundedText<MAX>

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

Builds the text from any string.

Errors

Returns InvalidBoundedText::Blank before InvalidBoundedText::TooLong, so a whitespace-only value reports as blank.

impl<const MAX: usize> BoundedText<MAX>

pub fn as_str(&self) -> &str

The validated text.

Trait Implementations

impl<const MAX: usize> AsRef<str> for BoundedText<MAX>

fn as_ref(&self) -> &str

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

impl<const MAX: usize> Borrow<str> for BoundedText<MAX>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<const MAX: usize> Clone for BoundedText<MAX>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MAX: usize> Debug for BoundedText<MAX>

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

Formats the value using the given formatter.

impl<'de, const MAX: usize> Deserialize<'de> for BoundedText<MAX>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const MAX: usize> Display for BoundedText<MAX>

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

Formats the value using the given formatter.

impl<const MAX: usize> Eq for BoundedText<MAX>

impl<const MAX: usize> From<BoundedText<MAX>> for String

fn from(value: BoundedText<MAX>) -> Self

Converts to this type from the input type.

impl<const MAX: usize> FromStr for BoundedText<MAX>

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<const MAX: usize> Hash for BoundedText<MAX>

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: usize> PartialEq for BoundedText<MAX>

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

Equality operator ==.

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

Inequality operator !=.

impl<const MAX: usize> PartialEq<&str> for BoundedText<MAX>

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

Equality operator ==.

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

Inequality operator !=.

impl<const MAX: usize> PartialEq<str> for BoundedText<MAX>

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

Equality operator ==.

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

Inequality operator !=.

impl<const MAX: usize> Serialize for BoundedText<MAX>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const MAX: usize> StructuralPartialEq for BoundedText<MAX>

impl<const MAX: usize> TryFrom<String> for BoundedText<MAX>

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.