Enum spinoso_string::CenterError

pub enum CenterError {
    ZeroWidthPadding,
}

Error returned when failing to construct a Center iterator.

This error is returned from String::center. See its documentation for more detail.

This error corresponds to the Ruby ArgumentError Exception class.

When the std feature of spinoso-string is enabled, this struct implements std::error::Error.

Variants

ZeroWidthPadding

Error returned when calling String::center with an empty padding bytestring.

Implementations

impl CenterError

pub const EXCEPTION_TYPE: &'static str

pub const fn zero_width_padding() -> Self

Create a new zero width padding CenterError.

Examples

use spinoso_string::CenterError;

const ERR: CenterError = CenterError::zero_width_padding();
assert_eq!(ERR.message(), "zero width padding");

pub const fn message(self) -> &'static str

Retrieve the exception message associated with this center error.

Examples

let err = CenterError::zero_width_padding();
assert_eq!(err.message(), "zero width padding");

Trait Implementations

impl Clone for CenterError

fn clone(&self) -> CenterError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CenterError

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

Formats the value using the given formatter.

impl Display for CenterError

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

Formats the value using the given formatter.

impl Error for CenterError

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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

impl Hash for CenterError

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for CenterError

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

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<CenterError> for CenterError

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

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

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

This method tests for !=.

impl PartialOrd<CenterError> for CenterError

fn partial_cmp(&self, other: &CenterError) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl Copy for CenterError

impl Eq for CenterError

impl StructuralEq for CenterError

impl StructuralPartialEq for CenterError