Struct soft_ascii_string::SoftAsciiString

pub struct SoftAsciiString(_);

a String wrapper with an additional "is us-ascii" soft constraint

Methods

impl SoftAsciiString

pub fn from_unchecked<S: Into<String>>(s: S) -> Self

pub fn from_string_unchecked<S: Into<String>>(s: S) -> Self

Deprecated since 1.0.0:

use from_unchecked

pub fn from_string<S>(source: S) -> Result<Self, FromSourceError<S>> where
    S: Debug + AsRef<str> + Into<String>, 

pub fn new() -> Self

pub fn with_capacity(cap: usize) -> Self

pub fn revalidate_soft_constraint(self) -> Result<SoftAsciiString, String>

pub fn inner_string_mut(&mut self) -> &mut String

pub fn inner_string(&self) -> &String

pub fn push_str(&mut self, other: &SoftAsciiStr)

pub fn into_bytes(self) -> Vec<u8>

pub fn push(&mut self, ch: SoftAsciiChar)

pub fn pop(&mut self) -> Option<SoftAsciiChar>

pub fn remove(&mut self, idx: usize) -> SoftAsciiChar

pub fn insert(&mut self, idx: usize, ch: SoftAsciiChar)

pub fn insert_str(&mut self, idx: usize, string: &SoftAsciiStr)

pub fn as_soft_ascii_str(&self) -> &SoftAsciiStr

pub fn as_soft_ascii_str_mut(&mut self) -> &mut SoftAsciiStr

pub fn split_off(&mut self, at: usize) -> SoftAsciiString

pub fn into_boxed_soft_ascii_str(self) -> Box<SoftAsciiStr>

pub fn into_boxed_str(self) -> Box<str>

pub fn is_ascii(&self) -> bool

impl SoftAsciiString

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

pub fn capacity(&self) -> usize

pub fn len(&self) -> usize

pub fn as_str(&self) -> &str

pub fn is_empty(&self) -> bool

impl SoftAsciiString

pub fn reserve(&mut self, additional: usize)

pub fn reserve_exact(&mut self, additional: usize)

pub fn shrink_to_fit(&mut self)

pub fn truncate(&mut self, new_len: usize)

pub fn clear(&mut self)

Methods from Deref<Target = SoftAsciiStr>

pub fn revalidate_soft_constraint(&self) -> Result<&Self, FromSourceError<&str>>

reruns checks if the "is us-ascii" soft constraint is still valid

pub fn as_str(&self) -> &str

Important traits for SoftAsciiLines<'a>

impl<'a> Iterator for SoftAsciiLines<'a> type Item = &'a SoftAsciiStr;

pub fn lines(&self) -> SoftAsciiLines

Important traits for SoftAsciiSplitWhitespace<'a>

impl<'a> Iterator for SoftAsciiSplitWhitespace<'a> type Item = &'a SoftAsciiStr;

pub fn split_whitespace(&self) -> SoftAsciiSplitWhitespace

Important traits for SoftAsciiCharIndices<'a>

impl<'a> Iterator for SoftAsciiCharIndices<'a> type Item = (usize, SoftAsciiChar);

pub fn char_indices(&self) -> SoftAsciiCharIndices

Important traits for SoftAsciiChars<'a>

impl<'a> Iterator for SoftAsciiChars<'a> type Item = SoftAsciiChar;

pub fn chars(&self) -> SoftAsciiChars

pub fn split_at(&self, mid: usize) -> (&SoftAsciiStr, &SoftAsciiStr)

pub unsafe fn slice_unchecked(&self, begin: usize, end: usize) -> &SoftAsciiStr

pub fn inner_str_mut(&mut self) -> &mut str

returns a mutable str reference to the inner buffer

Soft Constraint

be aware that it is very easy to introduce bugs when directly editing a SoftAsciiStr as an str. Still compared to a AsciiStr implementation this won't introduce unsafety, just possible brakeage of the soft constraint that the data should be ascii.

pub fn parse<F>(&self) -> Result<F, <F as FromStr>::Err> where
    F: FromStr, 

pub fn to_lowercase(&self) -> SoftAsciiString

pub fn to_uppercase(&self) -> SoftAsciiString

pub fn repeat(&self, n: usize) -> SoftAsciiString

pub fn trim_right(&self) -> &SoftAsciiStr

pub fn trim_left(&self) -> &SoftAsciiStr

pub fn trim(&self) -> &SoftAsciiStr

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn is_char_boundary(&self, index: usize) -> bool

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

pub fn encode_utf16(&self) -> EncodeUtf16

pub fn is_ascii(&self) -> bool

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

Trait Implementations

impl AsRef<SoftAsciiStr> for SoftAsciiString

fn as_ref(&self) -> &SoftAsciiStr

Performs the conversion.

impl AsRef<str> for SoftAsciiString

fn as_ref(&self) -> &str

Performs the conversion.

impl AsRef<[u8]> for SoftAsciiString

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl AsRef<OsStr> for SoftAsciiString

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl AsRef<Path> for SoftAsciiString

fn as_ref(&self) -> &Path

Performs the conversion.

impl Into<Vec<u8>> for SoftAsciiString

fn into(self) -> Vec<u8>

Performs the conversion.

impl Into<String> for SoftAsciiString

fn into(self) -> String

Performs the conversion.

impl<'a> From<Cow<'a, SoftAsciiStr>> for SoftAsciiString

fn from(cow: Cow<'a, SoftAsciiStr>) -> Self

Performs the conversion.

impl<'a> From<&'a SoftAsciiStr> for SoftAsciiString

fn from(s: &'a SoftAsciiStr) -> Self

Performs the conversion.

impl From<Box<SoftAsciiStr>> for SoftAsciiString

fn from(b: Box<SoftAsciiStr>) -> SoftAsciiString

Performs the conversion.

impl Extend<SoftAsciiChar> for SoftAsciiString

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = SoftAsciiChar>, 

Extends a collection with the contents of an iterator.

impl<'a> Extend<&'a SoftAsciiChar> for SoftAsciiString

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = &'a SoftAsciiChar>, 

Extends a collection with the contents of an iterator.

impl Extend<SoftAsciiString> for SoftAsciiString

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = SoftAsciiString>, 

Extends a collection with the contents of an iterator.

impl<'a> Extend<&'a SoftAsciiStr> for SoftAsciiString

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = &'a SoftAsciiStr>, 

Extends a collection with the contents of an iterator.

impl<'a> Extend<Cow<'a, SoftAsciiStr>> for SoftAsciiString

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = Cow<'a, SoftAsciiStr>>, 

Extends a collection with the contents of an iterator.

impl Clone for SoftAsciiString

fn clone(&self) -> SoftAsciiString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SoftAsciiString

fn default() -> SoftAsciiString

Returns the "default value" for a type.

impl Eq for SoftAsciiString

impl Ord for SoftAsciiString

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

Restrict a value to a certain interval.

impl PartialEq<SoftAsciiString> for SoftAsciiStr

fn eq(&self, other: &SoftAsciiString) -> 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<'a> PartialEq<SoftAsciiString> for &'a SoftAsciiStr

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

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

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

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

This method tests for !=.

impl PartialEq<SoftAsciiString> for str

fn eq(&self, other: &SoftAsciiString) -> 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<'a> PartialEq<&'a str> for SoftAsciiString

fn eq(&self, other: &&'a 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<'a> PartialEq<SoftAsciiString> for &'a str

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

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<String> for SoftAsciiString

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<SoftAsciiString> for String

fn eq(&self, other: &SoftAsciiString) -> 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<'a> PartialEq<&'a SoftAsciiStr> for SoftAsciiString

fn eq(&self, other: &&'a SoftAsciiStr) -> 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<'a> PartialEq<SoftAsciiString> for Cow<'a, str>

fn eq(&self, other: &SoftAsciiString) -> 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<'a> PartialEq<Cow<'a, str>> for SoftAsciiString

fn eq(&self, other: &Cow<'a, 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<'a> PartialEq<SoftAsciiString> for Cow<'a, SoftAsciiStr>

fn eq(&self, other: &SoftAsciiString) -> 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<'a> PartialEq<Cow<'a, SoftAsciiStr>> for SoftAsciiString

fn eq(&self, other: &Cow<'a, SoftAsciiStr>) -> 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 PartialOrd<SoftAsciiString> for SoftAsciiString

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

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

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

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

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

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

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

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

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

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

impl Display for SoftAsciiString

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

Formats the value using the given formatter.

impl Debug for SoftAsciiString

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

Formats the value using the given formatter.

impl FromStr for SoftAsciiString

type Err = StringFromStrError

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<'a> Add<&'a SoftAsciiStr> for SoftAsciiString

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: &'a SoftAsciiStr) -> Self

Performs the + operation.

impl<'a> AddAssign<&'a SoftAsciiStr> for SoftAsciiString

fn add_assign(&mut self, other: &'a SoftAsciiStr)

Performs the += operation.

impl Deref for SoftAsciiString

type Target = SoftAsciiStr

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for SoftAsciiString

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Index<Range<usize>> for SoftAsciiString

type Output = SoftAsciiStr

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for SoftAsciiString

type Output = SoftAsciiStr

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for SoftAsciiString

type Output = SoftAsciiStr

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for SoftAsciiString

type Output = SoftAsciiStr

The returned type after indexing.

fn index(&self, index: RangeFull) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<Range<usize>> for SoftAsciiString

fn index_mut(&mut self, index: Range<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeFrom<usize>> for SoftAsciiString

fn index_mut(&mut self, index: RangeFrom<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeTo<usize>> for SoftAsciiString

fn index_mut(&mut self, index: RangeTo<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeFull> for SoftAsciiString

fn index_mut(&mut self, index: RangeFull) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Hash for SoftAsciiString

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 FromIterator<SoftAsciiChar> for SoftAsciiString

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = SoftAsciiChar>, 

Creates a value from an iterator.

impl<'a> FromIterator<&'a SoftAsciiChar> for SoftAsciiString

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = &'a SoftAsciiChar>, 

Creates a value from an iterator.

impl FromIterator<SoftAsciiString> for SoftAsciiString

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = SoftAsciiString>, 

Creates a value from an iterator.

impl<'a> FromIterator<Cow<'a, SoftAsciiStr>> for SoftAsciiString

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = Cow<'a, SoftAsciiStr>>, 

Creates a value from an iterator.

impl<'a> FromIterator<&'a SoftAsciiStr> for SoftAsciiString

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = &'a SoftAsciiStr>, 

Creates a value from an iterator.

impl Borrow<str> for SoftAsciiString

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Borrow<SoftAsciiStr> for SoftAsciiString

fn borrow(&self) -> &SoftAsciiStr

Immutably borrows from an owned value.

impl ToSocketAddrs for SoftAsciiString

type Iter = IntoIter<SocketAddr>

Returned iterator over socket addresses which this type may correspond to.

fn to_socket_addrs(&self) -> Result<IntoIter<SocketAddr>>

Converts this object to an iterator of resolved SocketAddrs.