Struct const_format::AsciiStr

pub struct AsciiStr<'a>(_);

An ascii string slice.

You can also construct an AsciiStr at compile-time with the ascii_str macro, erroring at compile if the constant isn't ascii.

Example

use const_format::wrapper_types::{AsciiStr, NotAsciiError};
use const_format::ascii_str;

const HELLO: AsciiStr = unwrap_ascii(AsciiStr::new(b"hello"));
const EURO: AsciiStr = unwrap_ascii(AsciiStr::new("foo €".as_bytes()));

assert_eq!(HELLO.as_str(), "hello");
assert_eq!(EURO.as_str(), "<error>");
assert_eq!(AsciiStr::new("foo €".as_bytes()), Err(NotAsciiError{invalid_from: 4}));

const fn unwrap_ascii(res: Result<AsciiStr<'_>, NotAsciiError>) -> AsciiStr<'_> {
    match res {
        Ok(x) => x,
        Err(_) => ascii_str!("<error>"),
    }
}

Implementations

impl<'a> AsciiStr<'a>

pub const fn from_str(s: &'a str) -> Result<Self, NotAsciiError>

Constructs this AsciiStr from a possibly non-ascii str slice.

Returns a NonAsciiError error on the first non-ascii byte.

Example

use const_format::wrapper_types::{AsciiStr, NotAsciiError};

let ok = AsciiStr::from_str("foo bar").unwrap();

assert_eq!(ok.as_str(), "foo bar");
assert_eq!(AsciiStr::from_str("foo bar ½"), Err(NotAsciiError{invalid_from: 8}));

pub const fn new(s: &'a [u8]) -> Result<Self, NotAsciiError>

Constructs this AsciiStr from a possibly non-ascii byte slice.

Returns a NonAsciiError error on the first non-ascii byte.

Example

use const_format::wrapper_types::{AsciiStr, NotAsciiError};

let ok = AsciiStr::new(b"foo bar").unwrap();

assert_eq!(ok.as_str(), "foo bar");
assert_eq!(AsciiStr::new(b"foo bar \x80"), Err(NotAsciiError{invalid_from: 8}));

pub const fn empty() -> Self

Constructs an empty AsciiStr

Example

use const_format::AsciiStr;

assert_eq!(AsciiStr::empty().as_str(), "");

pub const fn len(self) -> usize

Queries the length of the AsciiStr

Example

use const_format::{AsciiStr, ascii_str};

assert_eq!(AsciiStr::empty().len(), 0);
assert_eq!(ascii_str!("hello").len(), 5);

pub const fn is_empty(self) -> bool

Queries whether this AsciiStr is empty.

Example

use const_format::{AsciiStr, ascii_str};

assert_eq!(AsciiStr::empty().is_empty(), true);
assert_eq!(ascii_str!("hello").is_empty(), false);

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

Accessor for the wrapped ascii string.

Example

use const_format::{AsciiStr, ascii_str};

assert_eq!(AsciiStr::empty().as_bytes(), b"");
assert_eq!(ascii_str!("hello").as_bytes(), b"hello");

pub fn as_str(self) -> &'a str

Accessor for the wrapped ascii string.

Example

use const_format::{AsciiStr, ascii_str};

assert_eq!(AsciiStr::empty().as_str(), "");
assert_eq!(ascii_str!("hello").as_str(), "hello");

impl<'_> AsciiStr<'_>

pub const fn const_display_fmt(
    &self,
    f: &mut Formatter<'_>
) -> Result<(), Error>

pub const fn const_debug_fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Trait Implementations

impl<'a> Clone for AsciiStr<'a>

fn clone(&self) -> AsciiStr<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for AsciiStr<'a>

impl<'a> Debug for AsciiStr<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for AsciiStr<'a>

impl<'_> FormatMarker for AsciiStr<'_>

type Kind = IsNotStdKind

What kind of type this is, this can be one of:

type This = Self

The type after dereferencing, implemented as type This = Self; for all non-reference types

impl<'a> Hash for AsciiStr<'a>

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> Ord for AsciiStr<'a>

fn cmp(&self, other: &AsciiStr<'a>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<'a> PartialEq<AsciiStr<'a>> for AsciiStr<'a>

fn eq(&self, other: &AsciiStr<'a>) -> bool

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

fn ne(&self, other: &AsciiStr<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<AsciiStr<'a>> for AsciiStr<'a>

fn partial_cmp(&self, other: &AsciiStr<'a>) -> Option<Ordering>

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

fn lt(&self, other: &AsciiStr<'a>) -> bool

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

fn le(&self, other: &AsciiStr<'a>) -> bool

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

fn gt(&self, other: &AsciiStr<'a>) -> bool

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

fn ge(&self, other: &AsciiStr<'a>) -> bool

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

impl<'a> StructuralEq for AsciiStr<'a>

impl<'a> StructuralPartialEq for AsciiStr<'a>