Struct artichoke_backend::extn::core::exception::StopIteration
source · [−]pub struct StopIteration { /* private fields */ }
Expand description
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
sourceimpl StopIteration
impl StopIteration
sourcepub const fn new() -> 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");
sourcepub const fn with_message(message: &'static str) -> 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");
sourcepub fn message(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
pub fn message(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [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");
Trait Implementations
sourceimpl Clone for StopIteration
impl Clone for StopIteration
sourcefn clone(&self) -> StopIteration
fn clone(&self) -> StopIteration
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for StopIteration
impl Debug for StopIteration
sourceimpl Default for StopIteration
impl Default for StopIteration
sourcefn default() -> StopIteration
fn default() -> StopIteration
Returns the “default value” for a type. Read more
sourceimpl Display for StopIteration
impl Display for StopIteration
sourceimpl Error for StopIteration
impl Error for StopIteration
1.30.0 · sourcefn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
sourcefn backtrace(&self) -> Option<&Backtrace>
fn backtrace(&self) -> Option<&Backtrace>
backtrace
)Returns a stack backtrace, if available, of where this error occurred. Read more
1.0.0 · sourcefn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()
sourceimpl From<&'static [u8]> for StopIteration
impl From<&'static [u8]> for StopIteration
sourcefn from(message: &'static [u8]) -> StopIteration
fn from(message: &'static [u8]) -> StopIteration
Converts to this type from the input type.
sourceimpl From<&'static str> for StopIteration
impl From<&'static str> for StopIteration
sourcefn from(message: &'static str) -> StopIteration
fn from(message: &'static str) -> StopIteration
Converts to this type from the input type.
sourceimpl From<Cow<'static, str>> for StopIteration
impl From<Cow<'static, str>> for StopIteration
sourcefn from(message: Cow<'static, str>) -> StopIteration
fn from(message: Cow<'static, str>) -> StopIteration
Converts to this type from the input type.
sourceimpl From<StopIteration> for Error
impl From<StopIteration> for Error
sourcefn from(exception: StopIteration) -> Error
fn from(exception: StopIteration) -> Error
Converts to this type from the input type.
sourceimpl From<StopIteration> for Box<dyn RubyException>
impl From<StopIteration> for Box<dyn RubyException>
sourcefn from(exception: StopIteration) -> Box<dyn RubyException>
fn from(exception: StopIteration) -> Box<dyn RubyException>
Converts to this type from the input type.
sourceimpl From<String> for StopIteration
impl From<String> for StopIteration
sourcefn from(message: String) -> StopIteration
fn from(message: String) -> StopIteration
Converts to this type from the input type.
sourceimpl Hash for StopIteration
impl Hash for StopIteration
sourceimpl Ord for StopIteration
impl Ord for StopIteration
sourceimpl PartialEq<StopIteration> for StopIteration
impl PartialEq<StopIteration> for StopIteration
sourcefn eq(&self, other: &StopIteration) -> bool
fn eq(&self, other: &StopIteration) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &StopIteration) -> bool
fn ne(&self, other: &StopIteration) -> bool
This method tests for !=
.
sourceimpl PartialOrd<StopIteration> for StopIteration
impl PartialOrd<StopIteration> for StopIteration
sourcefn partial_cmp(&self, other: &StopIteration) -> Option<Ordering>
fn partial_cmp(&self, other: &StopIteration) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl RubyException for StopIteration
impl RubyException for StopIteration
sourceimpl RubyException for StopIteration
impl RubyException for StopIteration
sourcefn vm_backtrace(&self, interp: &mut Artichoke) -> Option<Vec<Vec<u8>>>
fn vm_backtrace(&self, interp: &mut Artichoke) -> Option<Vec<Vec<u8>>>
Optional backtrace specified by a Vec
of frames.
sourcefn as_mrb_value(&self, interp: &mut Artichoke) -> Option<mrb_value>
fn as_mrb_value(&self, interp: &mut Artichoke) -> Option<mrb_value>
Return a raise-able sys::mrb_value
.
impl Eq for StopIteration
impl StructuralEq for StopIteration
impl StructuralPartialEq for StopIteration
Auto Trait Implementations
impl RefUnwindSafe for StopIteration
impl Send for StopIteration
impl Sync for StopIteration
impl Unpin for StopIteration
impl UnwindSafe for StopIteration
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more