Struct core::str::Utf8Chunk

1.79.0 · source ·
pub struct Utf8Chunk<'a> { /* private fields */ }
Expand description

An item returned by the Utf8Chunks iterator.

A Utf8Chunk stores a sequence of u8 up to the first broken character when decoding a UTF-8 string.

§Examples

// An invalid UTF-8 string
let bytes = b"foo\xF1\x80bar";

// Decode the first `Utf8Chunk`
let chunk = bytes.utf8_chunks().next().unwrap();

// The first three characters are valid UTF-8
assert_eq!("foo", chunk.valid());

// The fourth character is broken
assert_eq!(b"\xF1\x80", chunk.invalid());
Run

Implementations§

source§

impl<'a> Utf8Chunk<'a>

1.79.0 · source

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

Returns the next validated UTF-8 substring.

This substring can be empty at the start of the string or between broken UTF-8 characters.

1.79.0 · source

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

Returns the invalid sequence that caused a failure.

The returned slice will have a maximum length of 3 and starts after the substring given by valid. Decoding will resume after this sequence.

If empty, this is the last chunk in the string. If non-empty, an unexpected byte was encountered or the end of the input was reached unexpectedly.

Lossy decoding would replace this sequence with U+FFFD REPLACEMENT CHARACTER.

Trait Implementations§

1.79.0 · source§

impl<'a> Clone for Utf8Chunk<'a>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
1.79.0 · source§

impl<'a> Debug for Utf8Chunk<'a>

source§

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

Formats the value using the given formatter. Read more
1.79.0 · source§

impl<'a> PartialEq for Utf8Chunk<'a>

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.79.0 · source§

impl<'a> Eq for Utf8Chunk<'a>

1.79.0 · source§

impl<'a> StructuralPartialEq for Utf8Chunk<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Utf8Chunk<'a>

§

impl<'a> RefUnwindSafe for Utf8Chunk<'a>

§

impl<'a> Send for Utf8Chunk<'a>

§

impl<'a> Sync for Utf8Chunk<'a>

§

impl<'a> Unpin for Utf8Chunk<'a>

§

impl<'a> UnwindSafe for Utf8Chunk<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.