Skip to main content

Decoded

Struct Decoded 

Source
pub struct Decoded<'a> { /* private fields */ }
Expand description

Decoded input: the text, how it was encoded, and any decoding problems.

Implementations§

Source§

impl<'a> Decoded<'a>

Source

pub fn text(&self) -> &str

The decoded text, byte order marks included. Borrowed from the input for valid UTF-8.

Source

pub fn into_text(self) -> Cow<'a, str>

Consumes self, returning the text.

Source

pub const fn encoding(&self) -> Encoding

The detected encoding.

Source

pub const fn encoder(&self) -> Encoder

The encoder that writes text back in the detected encoding.

Source

pub fn invalid_runs(&self) -> &InvalidRuns

The invalid runs, in input order.

Source

pub fn diagnostics(&self) -> &[Diagnostic]

One error diagnostic per invalid run, in order; empty for valid input. With decode_with_limit, those of the first runs only (see Decoded::suppressed_diagnostics).

Source

pub const fn suppressed_diagnostics(&self) -> usize

How many invalid runs have no built diagnostic (past the budget of decode_with_limit); Decoded::invalid_runs is always complete, and run_diagnostic builds any run’s.

Source

pub fn is_valid(&self) -> bool

true when the input had no decoding error.

Source

pub fn into_parts(self) -> (Vec<Diagnostic>, InvalidRuns, Encoder, Cow<'a, str>)

Takes self apart (no copy of the runs): the built diagnostics, the invalid runs, the encoder, and the text.

Source

pub fn reencode(&self) -> Vec<u8> ⓘ

Re-encodes the unedited text, restoring invalid runs from their original bytes: always equal to the input.

Trait Implementations§

Source§

impl<'a> Clone for Decoded<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Decoded<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for Decoded<'a>

Source§

impl<'a> PartialEq for Decoded<'a>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for Decoded<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Decoded<'a>

§

impl<'a> RefUnwindSafe for Decoded<'a>

§

impl<'a> Send for Decoded<'a>

§

impl<'a> Sync for Decoded<'a>

§

impl<'a> Unpin for Decoded<'a>

§

impl<'a> UnsafeUnpin for Decoded<'a>

§

impl<'a> UnwindSafe for Decoded<'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§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.