Struct soma::NameString

pub struct NameString { /* fields omitted */ }

Methods

impl NameString

pub fn try_from(s: impl AsRef<str>) -> SomaResult<NameString>

Methods from Deref<Target = String>

pub fn as_str(&self) -> &str

Extracts a string slice containing the entire String.

Examples

Basic usage:

let s = String::from("foo");

assert_eq!("foo", s.as_str());

pub fn capacity(&self) -> usize

Returns this String's capacity, in bytes.

Examples

Basic usage:

let s = String::with_capacity(10);

assert!(s.capacity() >= 10);

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

Returns a byte slice of this String's contents.

The inverse of this method is from_utf8.

Examples

Basic usage:

let s = String::from("hello");

assert_eq!(&[104, 101, 108, 108, 111], s.as_bytes());

pub fn len(&self) -> usize

Returns the length of this String, in bytes.

Examples

Basic usage:

let a = String::from("foo");

assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if this String has a length of zero, and false otherwise.

Examples

Basic usage:

let mut v = String::new();
assert!(v.is_empty());

v.push('a');
assert!(!v.is_empty());

Trait Implementations

impl PartialOrd<NameString> for NameString

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

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

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

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

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

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

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

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

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

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

impl PartialEq<NameString> for NameString

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

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

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

This method tests for !=.

impl PartialEq<String> for NameString

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

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

#[must_use]

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

This method tests for !=.

impl PartialEq<str> for NameString

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

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

#[must_use]

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

This method tests for !=.

impl PartialEq<NameString> for String

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

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

#[must_use]

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

This method tests for !=.

impl PartialEq<NameString> for str

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

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

#[must_use]

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

This method tests for !=.

impl AsRef<str> for NameString

fn as_ref(&self) -> &str

Performs the conversion.

impl AsRef<Path> for NameString

fn as_ref(&self) -> &Path

Performs the conversion.

impl Clone for NameString

fn clone(&self) -> NameString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for NameString

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

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

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

impl Eq for NameString

impl Display for NameString

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

Formats the value using the given formatter.

impl Debug for NameString

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

Formats the value using the given formatter.

impl Hash for NameString

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, 

Feeds a slice of this type into the given [Hasher].

impl Deref for NameString

type Target = String

The resulting type after dereferencing.

fn deref(&self) -> &String

Dereferences the value.

impl Serialize for NameString

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for NameString

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.