Struct FieldText 

pub struct FieldText<'string>(/* private fields */);

A wrapper for &str that is checked to be printable ASCII, which is defined as not containing control characters in RFC8907 section 3.7.

This type implements TryFrom<&str> and TryFrom<&[u8]>; in both cases, an invalid argument will be returned as an Err variant.

Examples

Conversions from &str:

use tacacs_plus_protocol::FieldText;

let valid_ascii = "a string";
assert!(FieldText::try_from(valid_ascii).is_ok());

let beyond_ascii = "💀";
assert!(FieldText::try_from(beyond_ascii).is_err());

Conversions from &[u8]:

let valid_slice = b"this is (almost) a string";
assert!(FieldText::try_from(valid_slice.as_slice()).is_ok());

let not_printable = b"all ASCII characters with - oh no! - a\ttab";
assert!(FieldText::try_from(not_printable.as_slice()).is_err());

let invalid_utf8 = [0x80]; // where'd the rest of the codepoint go?
assert!(FieldText::try_from(invalid_utf8.as_slice()).is_err());

If the std feature is enabled, the FieldText::from_string_lossy() constructor is also available in case a .try_into().unwrap() is undesirable:

let already_valid = "all ASCII!";
let valid_text = FieldText::from_string_lossy(String::from(already_valid));
assert_eq!(valid_text, already_valid);

let unicode_fun = "\tsome chars and ✨emojis✨ (and a quote: ')";
let escaped_text = FieldText::from_string_lossy(String::from(unicode_fun));
assert_eq!(escaped_text, "\\tsome chars and \\u{2728}emojis\\u{2728} (and a quote: ')");

// now that escaped_text is valid ASCII, a .try_into().unwrap() should be guaranteed
// not to panic with the escaped string
let _: FieldText<'_> = escaped_text.as_ref().try_into().unwrap();

Implementations

impl FieldText<'_>

pub fn from_string_lossy(string: String) -> FieldText<'static>

Available on crate feature std only.

Creates a FieldText from a String, escaping any non-printable-ASCII characters as necessary.

pub fn into_owned(self) -> FieldText<'static>

Available on crate feature std only.

Converts this FieldText to one that owns its underlying data, extending its lifetime to 'static.

impl<'string> FieldText<'string>

pub fn len(&self) -> usize

Gets the length of the underlying &str.

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

Gets the byte slice representation of the underlying &str.

pub fn is_empty(&self) -> bool

Returns true if the underlying &str is empty.

pub fn contains_any(&self, characters: &[char]) -> bool

Returns true if the underlying &str contains any of the provided characters, or false otherwise.

Trait Implementations

impl AsRef<str> for FieldText<'_>

fn as_ref(&self) -> &str

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

impl<'string> Clone for FieldText<'string>

fn clone(&self) -> FieldText<'string>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'string> Debug for FieldText<'string>

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

Formats the value using the given formatter.

impl<'string> Default for FieldText<'string>

fn default() -> FieldText<'string>

Returns the “default value” for a type.

impl Display for FieldText<'_>

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

Formats the value using the given formatter.

impl FromStr for FieldText<'static>

Available on crate feature std only.

type Err = InvalidText<String>

The associated error which can be returned from parsing.

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

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

impl<'string> Hash for FieldText<'string>

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<'string> Ord for FieldText<'string>

fn cmp(&self, other: &FieldText<'string>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn eq(&self, other: &FieldText<'_>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'string> PartialEq for FieldText<'string>

fn eq(&self, other: &FieldText<'string>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'string> PartialOrd for FieldText<'string>

fn partial_cmp(&self, other: &FieldText<'string>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'bytes> TryFrom<&'bytes [u8]> for FieldText<'bytes>

type Error = InvalidText<&'bytes [u8]>

The type returned in the event of a conversion error.

fn try_from(value: &'bytes [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'string> TryFrom<&'string str> for FieldText<'string>

type Error = InvalidText<&'string str>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for FieldText<'_>

Available on crate feature std only.

type Error = InvalidText<String>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'string> Eq for FieldText<'string>

impl<'string> StructuralPartialEq for FieldText<'string>