Struct CharsetEncodeError 

pub struct CharsetEncodeError { /* private fields */ }

Error reported by a charset encoder.

The error always carries the target charset, error kind, and operation index associated with the failure. For buffer errors this is the caller-supplied output index. Errors tied to a raw code point or character value expose that value through Self::kind and Self::value.

Implementations

impl CharsetEncodeError

pub const fn new( charset: Charset, kind: CharsetEncodeErrorKind, index: usize, ) -> Self

Creates an encoding error.

Parameters

• charset: The target charset.
• kind: The failure category.
• index: The operation index associated with the failure.

Returns

Returns an encoding error carrying the supplied context.

pub const fn required(self) -> Option<usize>

Returns required output units for this encoding error, if reported.

Returns

Returns Some(required) for CharsetEncodeErrorKind::BufferTooSmall, otherwise None.

pub const fn available(self) -> Option<usize>

Returns available output units for this encoding error, if reported.

Returns

Returns Some(available) for CharsetEncodeErrorKind::BufferTooSmall, otherwise None.

pub const fn output_len(self) -> Option<usize>

Returns output length for this encoding error, if reported.

Returns

Returns Some(output_len) for CharsetEncodeErrorKind::InvalidOutputIndex, otherwise None.

pub const fn charset(self) -> Charset

Returns the target charset.

Returns

Returns the stored Charset.

pub const fn kind(self) -> CharsetEncodeErrorKind

Returns the encoding error kind.

Returns

Returns the stored CharsetEncodeErrorKind.

pub const fn index(self) -> usize

Returns the operation index associated with this error.

Returns

Returns the stored index.

pub const fn value(self) -> Option<u32>

Returns the raw value associated with this error.

Returns

Returns Some(value) when the error kind carries a raw code point or character value, or None for kinds without an associated value.

pub const fn offset_by(self, base: usize) -> Self

Offsets this error by a base unit index.

Parameters

• base: The base index to add to the stored index.

Returns

Returns a copy of this error with its index shifted by base.

If the shifted index cannot be represented, it is saturated to usize::MAX.

Trait Implementations

impl Clone for CharsetEncodeError

fn clone(&self) -> CharsetEncodeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CharsetEncodeError

impl Debug for CharsetEncodeError

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

Formats the value using the given formatter.

impl Display for CharsetEncodeError

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

Formats this encoding error.

Parameters

• formatter: The formatter receiving the diagnostic message.

Errors

Returns any formatting error reported by formatter.

impl Eq for CharsetEncodeError

impl Error for CharsetEncodeError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<CharsetEncodeError> for CharsetConvertError

fn from(source: CharsetEncodeError) -> Self

Converts to this type from the input type.

impl PartialEq for CharsetEncodeError

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