Struct Wtf8Atom

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

Clone-on-write WTF-8 string.

See [tendril] for more details.

Implementations

impl Wtf8Atom

pub fn new<S>(s: S) -> Self

where Wtf8Atom: From<S>,

Creates a new Wtf8Atom from a string.

pub fn as_wtf8(&self) -> &Wtf8

pub fn as_atom(&self) -> Option<&Atom>

pub fn to_atom_lossy(&self) -> Cow<'_, Atom>

Returns the UTF-8 Atom representation, borrowing when possible.

pub fn try_into_atom(self) -> Result<Atom, Wtf8Atom>

Try to convert this to a UTF-8 Atom.

Returns Atom if the string is valid UTF-8, otherwise returns the original Wtf8Atom.

pub unsafe fn from_bytes_unchecked(bytes: &[u8]) -> Self

Creates a new Wtf8Atom from a byte slice.

Safety

The caller must ensure that bytes is a well-formed WTF-8 byte sequence.

See hstr::wtf8::Wtf8::from_bytes_unchecked for more details.

Methods from Deref<Target = Wtf8>

pub fn len(&self) -> usize

Return the length, in WTF-8 bytes.

pub fn is_empty(&self) -> bool

Return true if the string has a length of zero bytes.

pub fn is_ascii(&self) -> bool

Return true if the string contains only ASCII characters.

pub fn slice(&self, begin: usize, end: usize) -> &Wtf8

Return a slice of the given string for the byte range [begin..end).

Failure

Fails when begin and end do not point to code point boundaries, or point beyond the end of the string.

pub fn slice_from(&self, begin: usize) -> &Wtf8

Return a slice of the given string from byte begin to its end.

Failure

Fails when begin is not at a code point boundary, or is beyond the end of the string.

pub fn slice_to(&self, end: usize) -> &Wtf8

Return a slice of the given string from its beginning to byte end.

Failure

Fails when end is not at a code point boundary, or is beyond the end of the string.

pub fn ascii_byte_at(&self, position: usize) -> u8

Return the code point at position if it is in the ASCII range, or `b’\xFF’ otherwise.

Failure

Fails if position is beyond the end of the string.

pub fn code_points(&self) -> Wtf8CodePoints<'_>

Return an iterator for the string’s code points.

pub fn contains_char(&self, ch: char) -> bool

Returns true if this WTF-8 string contains the given character.

pub fn contains(&self, code_point: CodePoint) -> bool

Returns true if this WTF-8 string contains the given code point.

pub fn starts_with(&self, pattern: &str) -> bool

Returns true if this WTF-8 string starts with the given UTF-8 string.

pub fn as_str(&self) -> Option<&str>

Try to convert the string to UTF-8 and return a &str slice.

Return None if the string contains surrogates.

This does not copy the data.

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

Return the underlying WTF-8 bytes.

pub fn to_string_lossy(&self) -> Cow<'_, str>

Lossily convert the string to UTF-8. Return an UTF-8 &str slice if the contents are well-formed in UTF-8.

Surrogates are replaced with "\u{FFFD}" (the replacement character “�”).

This only copies the data if necessary (if it contains any surrogate).

pub fn to_ill_formed_utf16(&self) -> IllFormedUtf16CodeUnits<'_>

Convert the WTF-8 string to potentially ill-formed UTF-16 and return an iterator of 16-bit code units.

This is lossless: calling Wtf8Buf::from_ill_formed_utf16 on the resulting code units would always return the original WTF-8 string.

pub fn to_uppercase(&self) -> Wtf8Buf

Returns the uppercase equivalent of this wtf8 slice, as a new Wtf8Buf.

pub fn to_lowercase(&self) -> Wtf8Buf

Returns the lowercase equivalent of this wtf8 slice, as a new Wtf8Buf.

Trait Implementations

impl Archive for Wtf8Atom

NOT A PUBLIC API

type Archived = ArchivedVec<u8>

The archived representation of this type.

type Resolver = VecResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

impl Borrow<Wtf8Atom> for Atom

fn borrow(&self) -> &Wtf8Atom

Immutably borrows from an owned value.

impl<__C: Fallible + ?Sized> CheckBytes<__C> for Wtf8Atom

where <__C as Fallible>::Error: Trace, Wtf8Atom: CheckBytes<__C>,

unsafe fn check_bytes( value: *const Self, context: &mut __C, ) -> Result<(), <__C as Fallible>::Error>

Checks whether the given pointer points to a valid value within the given context.

impl Clone for Wtf8Atom

fn clone(&self) -> Wtf8Atom

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Wtf8Atom

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

Formats the value using the given formatter.

impl Default for Wtf8Atom

fn default() -> Wtf8Atom

Returns the “default value” for a type.

impl Deref for Wtf8Atom

type Target = Wtf8

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for Wtf8Atom

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<D> Deserialize<Wtf8Atom, D> for ArchivedVec<u8>

where D: ?Sized + Fallible, <D as Fallible>::Error: Source,

NOT A PUBLIC API

fn deserialize(&self, _: &mut D) -> Result<Wtf8Atom, <D as Fallible>::Error>

Deserializes using the given deserializer

impl From<&Wtf8Atom> for Wtf8Buf

fn from(s: &Wtf8Atom) -> Self

Converts to this type from the input type.

impl<T> From<T> for Wtf8Atom

where Wtf8Atom: From<T>,

fn from(s: T) -> Self

Converts to this type from the input type.

impl Hash for Wtf8Atom

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 Wtf8Atom

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

Restrict a value to a certain interval.

impl<T> PartialEq<T> for Wtf8Atom

where Wtf8Atom: PartialEq<T>, T: ?Sized,

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

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

fn partial_cmp(&self, other: &Self) -> 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<S: Fallible + Writer + Allocator + ?Sized> Serialize<S> for Wtf8Atom

where <S as Fallible>::Error: Source,

NOT A PUBLIC API

fn serialize(&self, serializer: &mut S) -> Result<Self::Resolver, S::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Serialize for Wtf8Atom

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Wtf8Atom

impl StructuralPartialEq for Wtf8Atom