Struct StopIteration

pub struct StopIteration { /* private fields */ }

Ruby StopIteration error type.

Descendants of class Exception are used to communicate between Kernel#raise and rescue statements in begin ... end blocks. Exception objects carry information about the exception – its type (the exception’s class name), an optional descriptive string, and optional traceback information. Exception subclasses may add additional information like NameError#name.

Implementations

impl StopIteration

pub const fn new() -> StopIteration

Construct a new, default StopIteration Ruby exception.

This constructor sets the exception message to StopIteration.

Examples

let exception = StopIteration::new();
assert_eq!(exception.message(), b"StopIteration");

pub const fn with_message(message: &'static str) -> StopIteration

Construct a new, StopIteration Ruby exception with the given message.

Examples

let exception = StopIteration::with_message("an error occurred");
assert_eq!(exception.message(), b"an error occurred");

pub fn message(&self) -> &[u8]

Return the message this Ruby exception was constructed with.

Examples

let exception = StopIteration::new();
assert_eq!(exception.message(), b"StopIteration");
let exception = StopIteration::from("something went wrong");
assert_eq!(exception.message(), b"something went wrong");

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

Return this Ruby exception’s class name.

Examples

let exception = StopIteration::new();
assert_eq!(exception.name(), "StopIteration");

Trait Implementations

impl Clone for StopIteration

fn clone(&self) -> StopIteration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StopIteration

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

Formats the value using the given formatter.

impl Default for StopIteration

fn default() -> StopIteration

Returns the “default value” for a type.

impl Display for StopIteration

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

Formats the value using the given formatter.

impl Error for StopIteration

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<&'static [u8]> for StopIteration

fn from(message: &'static [u8]) -> StopIteration

Converts to this type from the input type.

impl From<&'static str> for StopIteration

fn from(message: &'static str) -> StopIteration

Converts to this type from the input type.

impl From<Cow<'static, [u8]>> for StopIteration

fn from(message: Cow<'static, [u8]>) -> StopIteration

Converts to this type from the input type.

impl From<Cow<'static, str>> for StopIteration

fn from(message: Cow<'static, str>) -> StopIteration

Converts to this type from the input type.

impl From<StopIteration> for Error

fn from(exception: StopIteration) -> Error

Converts to this type from the input type.

impl From<String> for StopIteration

fn from(message: String) -> StopIteration

Converts to this type from the input type.

impl From<Vec<u8>> for StopIteration

fn from(message: Vec<u8>) -> StopIteration

Converts to this type from the input type.

impl Hash for StopIteration

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for StopIteration

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StopIteration

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl RubyException for StopIteration

fn message(&self) -> Cow<'_, [u8]>

Message of the Exception.

fn name(&self) -> Cow<'_, str>

Class name of the Exception.

fn vm_backtrace(&self, interp: &mut Artichoke) -> Option<Vec<Vec<u8>>>

Optional backtrace specified by a Vec of frames.

fn as_mrb_value(&self, interp: &mut Artichoke) -> Option<mrb_value>

Return a raise-able sys::mrb_value.

impl RubyException for StopIteration

fn message(&self) -> Cow<'_, [u8]>

The exception’s message.

fn name(&self) -> Cow<'_, str>

The exception’s class name.

impl Eq for StopIteration

impl StructuralPartialEq for StopIteration