Struct soft_ascii_string::SoftAsciiStr

pub struct SoftAsciiStr(_);

A str wrapper adding a "is us-ascii" soft constraint.

This means that it should be ascii but is not guaranteed to be ascii. Which means non ascii chars are not a safety issue just a potential bug.

This is useful for situations where:

1. you would have many unsafe from str conversions/"unnecessary" checks with a strict AsciiStr
2. you rarely have to strictly rely on the value being ascii

Note

Some functions which should be implemented directly on SoftAsciiStr like e.g. trim_matches are only provided through .as_str(). This is because the Pattern API and SliceIndex API is unstable i.e. can only be implemented in unstable for now. Once it gets stabilized (rust #27721/#35729) implementations can be added

Methods

impl SoftAsciiStr

pub fn from_unchecked(s: &str) -> &SoftAsciiStr

pub fn from_str_unchecked(s: &str) -> &SoftAsciiStr

Deprecated since 1.0.0:

use from_unchecked

pub fn from_unchecked_mut(s: &mut str) -> &mut SoftAsciiStr

pub fn from_str(source: &str) -> Result<&Self, FromSourceError<&str>>

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

pub fn into_soft_ascii_string(self: Box<SoftAsciiStr>) -> SoftAsciiString

pub fn from_boxed_str(bs: Box<str>) -> Box<SoftAsciiStr>

pub fn into_boxed_str(self: Box<SoftAsciiStr>) -> Box<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, 

impl SoftAsciiStr

pub fn to_lowercase(&self) -> SoftAsciiString

impl SoftAsciiStr

pub fn to_uppercase(&self) -> SoftAsciiString

impl SoftAsciiStr

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

impl SoftAsciiStr

pub fn trim_right(&self) -> &SoftAsciiStr

pub fn trim_left(&self) -> &SoftAsciiStr

pub fn trim(&self) -> &SoftAsciiStr

impl 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 SoftAsciiStr

fn as_ref(&self) -> &Self

Performs the conversion.

impl AsRef<str> for SoftAsciiStr

fn as_ref(&self) -> &str

Performs the conversion.

impl AsRef<[u8]> for SoftAsciiStr

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

Performs the conversion.

impl AsRef<OsStr> for SoftAsciiStr

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl AsRef<Path> for SoftAsciiStr

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<SoftAsciiStr> for SoftAsciiString

fn as_ref(&self) -> &SoftAsciiStr

Performs the conversion.

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

Important traits for SoftAsciiChars<'a>

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

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

Performs the conversion.

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

Important traits for SoftAsciiCharIndices<'a>

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

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

Performs the conversion.

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

Important traits for SoftAsciiLines<'a>

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

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

Performs the conversion.

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

Important traits for SoftAsciiSplitWhitespace<'a>

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

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

Performs the conversion.

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

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

Performs the conversion.

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

fn default() -> &'a SoftAsciiStr

Returns the "default value" for a type.

impl Eq for SoftAsciiStr

impl Ord for SoftAsciiStr

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

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

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

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

This method tests for !=.

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

fn eq(&self, other: &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 PartialEq<String> for SoftAsciiStr

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<'a> PartialEq<&'a SoftAsciiStr> for String

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

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<'a> PartialEq<SoftAsciiStr> for str

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

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<'a> PartialEq<SoftAsciiStr> for Cow<'a, SoftAsciiStr>

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

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<'a, 'b> PartialEq<&'b SoftAsciiStr> for Cow<'a, SoftAsciiStr>

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

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<'a> PartialEq<SoftAsciiStr> for Cow<'a, str>

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

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, 'b> PartialEq<&'b SoftAsciiStr> for Cow<'a, str>

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

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

fn eq(&self, other: &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 PartialEq<OsString> for SoftAsciiStr

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

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

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

fn eq(&self, other: &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 PartialEq<OsStr> for SoftAsciiStr

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

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

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

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

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

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

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

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

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

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

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

impl ToOwned for SoftAsciiStr

type Owned = SoftAsciiString

The resulting type after obtaining ownership.

fn to_owned(&self) -> SoftAsciiString

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

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

recently added

Uses borrowed data to replace owned data, usually by cloning.

impl Display for SoftAsciiStr

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

Formats the value using the given formatter.

impl Debug for SoftAsciiStr

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

Formats the value using the given formatter.

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 Index<Range<usize>> for SoftAsciiStr

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 SoftAsciiStr

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 SoftAsciiStr

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 SoftAsciiStr

type Output = SoftAsciiStr

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Hash for SoftAsciiStr

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

fn borrow(&self) -> &SoftAsciiStr

Immutably borrows from an owned value.

impl ToSocketAddrs for SoftAsciiStr

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.