Struct codepage_437::IntoCp437Error

pub struct IntoCp437Error { /* fields omitted */ }

A possible error value when converting a String into a cp437 byte vector.

This type is the error type for the into_cp437() function on IntoCp437. It is designed in such a way to carefully avoid reallocations: the into_string() function will give back the String that was used in the conversion attempt.

The Cp437Error type represents an error that may occur when converting a &str to a sequence of u8s. In this sense, it's an analogue to IntoCp437Error, and you can get one from a IntoCp437Error through the cp437_error() function.

Examples

// some unrepresentable chracters, in a String
let word = "Eżektor".to_string();

let value = word.into_cp437(&CP437_CONTROL);

assert!(value.is_err());
assert_eq!(value.unwrap_err().into_string(), "Eżektor".to_string());

Methods

impl IntoCp437Error

pub fn as_str(&self) -> &str

Returns a &str that was attempted to convert to cp437.

Examples

// some unrepresentable chracters, in a String
let word = "Eżektor".to_string();

let value = word.into_cp437(&CP437_CONTROL);

assert_eq!(value.unwrap_err().as_str(), "Eżektor");

pub fn into_string(self) -> String

Returns the String that was attempted to convert to cp437.

This function is carefully constructed to avoid allocation. It will consume the error, moving out the string, so that a copy of the string does not need to be made.

Examples

// some unrepresentable chracters, in a String
let word = "Eżektor".to_string();

let value = word.into_cp437(&CP437_CONTROL);

assert_eq!(value.unwrap_err().into_string(), "Eżektor".to_string());

pub fn cp437_error(&self) -> Cp437Error

Fetch a Cp437Error to get more details about the conversion failure.

The Cp437Error type represents an error that may occur when converting a &str to a sequence of u8s. In this sense, it's an analogue to IntoCp437Error. See its documentation for more details on using it.

Examples

// some unrepresentable chracters, in a String
let word = "Eżektor".to_string();

let error = word.into_cp437(&CP437_CONTROL).unwrap_err().cp437_error();

// the first character is unrepresentable here
assert_eq!(error.representable_up_to, 1);

Trait Implementations

impl Debug for IntoCp437Error

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for IntoCp437Error

fn clone(&self) -> IntoCp437Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for IntoCp437Error

fn hash<__H: Hasher>(&self, __arg_0: &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 Eq for IntoCp437Error

impl Ord for IntoCp437Error

fn cmp(&self, __arg_0: &IntoCp437Error) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl PartialEq for IntoCp437Error

fn eq(&self, __arg_0: &IntoCp437Error) -> bool

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

fn ne(&self, __arg_0: &IntoCp437Error) -> bool

This method tests for !=.

impl PartialOrd for IntoCp437Error

fn partial_cmp(&self, __arg_0: &IntoCp437Error) -> Option<Ordering>

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

fn lt(&self, __arg_0: &IntoCp437Error) -> bool

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

fn le(&self, __arg_0: &IntoCp437Error) -> bool

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

fn gt(&self, __arg_0: &IntoCp437Error) -> bool

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

fn ge(&self, __arg_0: &IntoCp437Error) -> bool

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