Struct strict_encoding::FieldName

pub struct FieldName(/* private fields */);

Implementations

impl FieldName

pub fn as_str(&self) -> &str

Returns string reference.

impl FieldName

pub fn to_ident(&self) -> Ident

Converts to identifier name.

pub fn into_ident(self) -> Ident

Converts into identifier name.

Methods from Deref<Target = AsciiString>

pub fn capacity(&self) -> usize

Returns the number of bytes that this ASCII string buffer can hold without reallocating.

Examples

let s = String::with_capacity(10);
assert!(s.capacity() >= 10);

pub fn len(&self) -> usize

Returns the number of bytes in this ASCII string.

Examples

let s = AsciiString::from_ascii("foo").unwrap();
assert_eq!(s.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the ASCII string contains zero bytes.

Examples

let mut s = AsciiString::new();
assert!(s.is_empty());
s.push(AsciiChar::from_ascii('a').unwrap());
assert!(!s.is_empty());

Methods from Deref<Target = AsciiStr>

pub fn as_str(&self) -> &str

Converts &self to a &str slice.

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

Converts &self into a byte slice.

pub fn as_slice(&self) -> &[AsciiChar]

Returns the entire string as slice of AsciiChars.

pub fn as_mut_slice(&mut self) -> &mut [AsciiChar]

Returns the entire string as mutable slice of AsciiChars.

pub fn as_ptr(&self) -> *const AsciiChar

Returns a raw pointer to the AsciiStr’s buffer.

The caller must ensure that the slice outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the AsciiStr may cause it’s buffer to be reallocated, which would also make any pointers to it invalid.

pub fn as_mut_ptr(&mut self) -> *mut AsciiChar

Returns an unsafe mutable pointer to the AsciiStr’s buffer.

The caller must ensure that the slice outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the AsciiStr may cause it’s buffer to be reallocated, which would also make any pointers to it invalid.

pub fn to_ascii_string(&self) -> AsciiString

Available on crate feature alloc only.

Copies the content of this AsciiStr into an owned AsciiString.

pub fn len(&self) -> usize

Returns the number of characters / bytes in this ASCII sequence.

Examples

let s = AsciiStr::from_ascii("foo").unwrap();
assert_eq!(s.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the ASCII slice contains zero bytes.

Examples

let mut empty = AsciiStr::from_ascii("").unwrap();
let mut full = AsciiStr::from_ascii("foo").unwrap();
assert!(empty.is_empty());
assert!(!full.is_empty());

pub fn chars(&self) -> Chars<'_>

Returns an iterator over the characters of the AsciiStr.

pub fn chars_mut(&mut self) -> CharsMut<'_>

Returns an iterator over the characters of the AsciiStr which allows you to modify the value of each AsciiChar.

pub fn split(&self, on: AsciiChar) -> impl DoubleEndedIterator

Returns an iterator over parts of the AsciiStr separated by a character.

Examples

let words = AsciiStr::from_ascii("apple banana lemon").unwrap()
    .split(AsciiChar::Space)
    .map(|a| a.as_str())
    .collect::<Vec<_>>();
assert_eq!(words, ["apple", "banana", "lemon"]);

pub fn lines(&self) -> impl DoubleEndedIterator

Returns an iterator over the lines of the AsciiStr, which are themselves AsciiStrs.

Lines are ended with either LineFeed (\n), or CarriageReturn then LineFeed (\r\n).

The final line ending is optional.

pub fn trim(&self) -> &AsciiStr

Returns an ASCII string slice with leading and trailing whitespace removed.

Examples

let example = AsciiStr::from_ascii("  \twhite \tspace  \t").unwrap();
assert_eq!("white \tspace", example.trim());

pub fn trim_start(&self) -> &AsciiStr

Returns an ASCII string slice with leading whitespace removed.

Examples

let example = AsciiStr::from_ascii("  \twhite \tspace  \t").unwrap();
assert_eq!("white \tspace  \t", example.trim_start());

pub fn trim_end(&self) -> &AsciiStr

Returns an ASCII string slice with trailing whitespace removed.

Examples

let example = AsciiStr::from_ascii("  \twhite \tspace  \t").unwrap();
assert_eq!("  \twhite \tspace", example.trim_end());

pub fn eq_ignore_ascii_case(&self, other: &AsciiStr) -> bool

Compares two strings case-insensitively.

pub fn make_ascii_uppercase(&mut self)

Replaces lowercase letters with their uppercase equivalent.

pub fn make_ascii_lowercase(&mut self)

Replaces uppercase letters with their lowercase equivalent.

pub fn to_ascii_uppercase(&self) -> AsciiString

Available on crate feature alloc only.

Returns a copy of this string where letters ‘a’ to ‘z’ are mapped to ‘A’ to ‘Z’.

pub fn to_ascii_lowercase(&self) -> AsciiString

Available on crate feature alloc only.

Returns a copy of this string where letters ‘A’ to ‘Z’ are mapped to ‘a’ to ‘z’.

pub fn first(&self) -> Option<AsciiChar>

Returns the first character if the string is not empty.

pub fn last(&self) -> Option<AsciiChar>

Returns the last character if the string is not empty.

Trait Implementations

impl AsRef<RString<AlphaSmallLodash, AlphaNumLodash, 1, IDENT_MAX_LEN>> for FieldName

fn as_ref(&self) -> &RString<AlphaSmallLodash, AlphaNumLodash, 1, IDENT_MAX_LEN>

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

impl AsRef<str> for FieldName

fn as_ref(&self) -> &str

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

impl Borrow<RString<AlphaSmallLodash, AlphaNumLodash, 1, IDENT_MAX_LEN>> for FieldName

fn borrow(&self) -> &RString<AlphaSmallLodash, AlphaNumLodash, 1, IDENT_MAX_LEN>

Immutably borrows from an owned value.

impl Borrow<str> for FieldName

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for FieldName

fn clone(&self) -> FieldName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldName

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

Formats the value using the given formatter.

impl Deref for FieldName

type Target = RString<AlphaSmallLodash, AlphaNumLodash, 1, IDENT_MAX_LEN>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for FieldName

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FieldName

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

Formats the value using the given formatter.

impl From<&'static str> for FieldName

fn from(ident: &'static str) -> Self

Converts to this type from the input type.

impl From<FieldName> for Ident

fn from(name: FieldName) -> Self

Converts to this type from the input type.

impl From<FieldName> for RString<AlphaSmallLodash, AlphaNumLodash, 1, IDENT_MAX_LEN>

fn from(wrapped: FieldName) -> Self

Converts to this type from the input type.

impl From<FieldName> for String

fn from(ident: FieldName) -> String

Converts to this type from the input type.

impl From<RString<AlphaSmallLodash, AlphaNumLodash, 1, IDENT_MAX_LEN>> for FieldName

fn from(v: RString<AlphaSmallLodash, AlphaNumLodash, 1, IDENT_MAX_LEN>) -> Self

Converts to this type from the input type.

impl FromStr for FieldName

type Err = <<FieldName as Wrapper>::Inner as FromStr>::Err

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 Hash for FieldName

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 Ord for FieldName

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

Restrict a value to a certain interval.

impl PartialEq for FieldName

fn eq(&self, other: &FieldName) -> 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 PartialOrd for FieldName

fn partial_cmp(&self, other: &FieldName) -> 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 Serialize for FieldName

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for FieldName

fn strict_decode(reader: &mut impl TypedRead) -> Result<Self, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictDumb for FieldName

fn strict_dumb() -> Self

impl StrictEncode for FieldName

fn strict_encode<W: TypedWrite>(&self, writer: W) -> Result<W>

fn strict_write(&self, writer: impl WriteRaw) -> Result<()>

impl StrictTuple for FieldName

const FIELD_COUNT: u8 = 1u8

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for FieldName

const STRICT_LIB_NAME: &'static str = STRICT_TYPES_LIB

fn strict_name() -> Option<TypeName>

impl TryFrom<String> for FieldName

type Error = InvalidRString

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Wrapper for FieldName

type Inner = RString<AlphaSmallLodash, AlphaNumLodash, 1, IDENT_MAX_LEN>

Inner type wrapped by the current newtype

fn from_inner(inner: Self::Inner) -> Self

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &Self::Inner

Returns reference to the inner representation for the wrapper type

fn into_inner(self) -> Self::Inner

Unwraps the wrapper returning the inner type

fn to_inner(&self) -> Self::Inner

where Self::Inner: Clone,

Clones inner data of the wrapped type and return them

impl Eq for FieldName

impl StrictProduct for FieldName

impl StructuralPartialEq for FieldName