Struct artichoke::prelude::SyntaxError
source · pub struct SyntaxError { /* private fields */ }
Expand description
Ruby SyntaxError
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§
source§impl SyntaxError
impl SyntaxError
sourcepub const fn new() -> SyntaxError
pub const fn new() -> SyntaxError
Construct a new, default SyntaxError
Ruby exception.
This constructor sets the exception message to SyntaxError
.
Examples
let exception = SyntaxError::new();
assert_eq!(exception.message(), b"SyntaxError");
sourcepub const fn with_message(message: &'static str) -> SyntaxError
pub const fn with_message(message: &'static str) -> SyntaxError
Construct a new, SyntaxError
Ruby exception with the given
message.
Examples
let exception = SyntaxError::with_message("an error occurred");
assert_eq!(exception.message(), b"an error occurred");
sourcepub fn message(&self) -> &[u8] ⓘ
pub fn message(&self) -> &[u8] ⓘ
Return the message this Ruby exception was constructed with.
Examples
let exception = SyntaxError::new();
assert_eq!(exception.message(), b"SyntaxError");
let exception = SyntaxError::from("something went wrong");
assert_eq!(exception.message(), b"something went wrong");
Trait Implementations§
source§impl Clone for SyntaxError
impl Clone for SyntaxError
source§fn clone(&self) -> SyntaxError
fn clone(&self) -> SyntaxError
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for SyntaxError
impl Debug for SyntaxError
source§impl Default for SyntaxError
impl Default for SyntaxError
source§fn default() -> SyntaxError
fn default() -> SyntaxError
Returns the “default value” for a type. Read more
source§impl Display for SyntaxError
impl Display for SyntaxError
source§impl Error for SyntaxError
impl Error for SyntaxError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
source§impl From<&'static [u8]> for SyntaxError
impl From<&'static [u8]> for SyntaxError
source§fn from(message: &'static [u8]) -> SyntaxError
fn from(message: &'static [u8]) -> SyntaxError
Converts to this type from the input type.
source§impl From<&'static str> for SyntaxError
impl From<&'static str> for SyntaxError
source§fn from(message: &'static str) -> SyntaxError
fn from(message: &'static str) -> SyntaxError
Converts to this type from the input type.
source§impl From<String> for SyntaxError
impl From<String> for SyntaxError
source§fn from(message: String) -> SyntaxError
fn from(message: String) -> SyntaxError
Converts to this type from the input type.
source§impl From<SyntaxError> for Error
impl From<SyntaxError> for Error
source§fn from(exception: SyntaxError) -> Error
fn from(exception: SyntaxError) -> Error
Converts to this type from the input type.
source§impl Hash for SyntaxError
impl Hash for SyntaxError
source§impl Ord for SyntaxError
impl Ord for SyntaxError
source§fn cmp(&self, other: &SyntaxError) -> Ordering
fn cmp(&self, other: &SyntaxError) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
Compares and returns the maximum of two values. Read more
source§impl PartialEq<SyntaxError> for SyntaxError
impl PartialEq<SyntaxError> for SyntaxError
source§fn eq(&self, other: &SyntaxError) -> bool
fn eq(&self, other: &SyntaxError) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<SyntaxError> for SyntaxError
impl PartialOrd<SyntaxError> for SyntaxError
source§fn partial_cmp(&self, other: &SyntaxError) -> Option<Ordering>
fn partial_cmp(&self, other: &SyntaxError) -> Option<Ordering>
1.0.0 · source§fn 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