Enum spinoso_string::OrdError

pub enum OrdError {
    InvalidUtf8ByteSequence,
    EmptyString,
}

Variants

InvalidUtf8ByteSequence

The first character in a conventionally UTF-8 String is an invalid UTF-8 byte sequence.

EmptyString

The given String is empty and has no first character.

Implementations

impl OrdError

pub const EXCEPTION_TYPE: &'static str

OrdError corresponds to an ArgumentError Ruby exception.

#[must_use]

pub const fn invalid_utf8_byte_sequence() -> Self

Construct a new OrdError for an invalid UTF-8 byte sequence.

Only conventionally UTF-8 Strings can generate this error.

Examples

use spinoso_string::{OrdError, String};

let s = String::utf8(b"\xFFabc".to_vec());
assert_eq!(s.ord(), Err(OrdError::invalid_utf8_byte_sequence()));

let s = String::binary(b"\xFFabc".to_vec());
assert_eq!(s.ord(), Ok(0xFF));

#[must_use]

pub const fn empty_string() -> Self

Construct a new OrdError for an empty String.

Empty Strings have no first character. Empty Strings with any encoding return this error.

Examples

use spinoso_string::{OrdError, String};

let s = String::utf8(b"\xFFabc".to_vec());
assert_eq!(s.ord(), Err(OrdError::invalid_utf8_byte_sequence()));

#[must_use]

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

Error message for this OrdError.

This message is suitable for generating an ArgumentError exception from this OrdError.

Examples

assert_eq!(OrdError::invalid_utf8_byte_sequence().message(), "invalid byte sequence in UTF-8");
assert_eq!(OrdError::empty_string().message(), "empty string");

Trait Implementations

impl Clone for OrdError

fn clone(&self) -> OrdError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrdError

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

Formats the value using the given formatter.

impl Display for OrdError

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

Formats the value using the given formatter.

impl Error for OrdError

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 OrdError

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 OrdError

fn cmp(&self, other: &OrdError) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<OrdError> for OrdError

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

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<OrdError> for OrdError

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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 OrdError

impl Eq for OrdError

impl StructuralEq for OrdError

impl StructuralPartialEq for OrdError