Struct artichoke::prelude::SyntaxError[][src]

pub struct SyntaxError { /* fields omitted */ }

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

impl SyntaxError[src]

#[must_use]
pub const fn new() -> SyntaxError
[src]

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");

#[must_use]
pub const fn with_message(message: &'static str) -> SyntaxError
[src]

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");

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

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");

#[must_use]
pub const fn name(&self) -> &'static str
[src]

Return this Ruby exception’s class name.

Examples

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

Trait Implementations

impl Clone for SyntaxError[src]

pub fn clone(&self) -> SyntaxError[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for SyntaxError[src]

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

Formats the value using the given formatter. Read more

impl Default for SyntaxError[src]

pub fn default() -> SyntaxError[src]

Returns the “default value” for a type. Read more

impl Display for SyntaxError[src]

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

Formats the value using the given formatter. Read more

impl Error for SyntaxError[src]

fn source(&self) -> Option<&(dyn Error + 'static)>1.30.0[src]

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

fn backtrace(&self) -> Option<&Backtrace>[src]

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

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

fn description(&self) -> &str1.0.0[src]

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>1.0.0[src]

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<&'static [u8]> for SyntaxError[src]

pub fn from(message: &'static [u8]) -> SyntaxError[src]

Performs the conversion.

impl From<&'static str> for SyntaxError[src]

pub fn from(message: &'static str) -> SyntaxError[src]

Performs the conversion.

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

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

Performs the conversion.

impl From<Cow<'static, str>> for SyntaxError[src]

pub fn from(message: Cow<'static, str>) -> SyntaxError[src]

Performs the conversion.

impl From<String> for SyntaxError[src]

pub fn from(message: String) -> SyntaxError[src]

Performs the conversion.

impl From<SyntaxError> for Error[src]

pub fn from(exception: SyntaxError) -> Error[src]

Performs the conversion.

impl From<Vec<u8, Global>> for SyntaxError[src]

pub fn from(message: Vec<u8, Global>) -> SyntaxError[src]

Performs the conversion.

impl Hash for SyntaxError[src]

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher
[src]

Feeds this value into the given Hasher. Read more

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

Feeds a slice of this type into the given Hasher. Read more

impl Ord for SyntaxError[src]

pub fn cmp(&self, other: &SyntaxError) -> Ordering[src]

This method returns an Ordering between self and other. Read more

#[must_use]
fn max(self, other: Self) -> Self
1.21.0[src]

Compares and returns the maximum of two values. Read more

#[must_use]
fn min(self, other: Self) -> Self
1.21.0[src]

Compares and returns the minimum of two values. Read more

#[must_use]
fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]

Restrict a value to a certain interval. Read more

impl PartialEq<SyntaxError> for SyntaxError[src]

pub fn eq(&self, other: &SyntaxError) -> bool[src]

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

pub fn ne(&self, other: &SyntaxError) -> bool[src]

This method tests for !=.

impl PartialOrd<SyntaxError> for SyntaxError[src]

pub fn partial_cmp(&self, other: &SyntaxError) -> Option<Ordering>[src]

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

#[must_use]
fn lt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn le(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]

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

impl RubyException for SyntaxError[src]

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

Message of the Exception. Read more

pub fn name(&self) -> Cow<'_, str>[src]

Class name of the Exception.

pub fn vm_backtrace(
    &self,
    interp: &mut Artichoke
) -> Option<Vec<Vec<u8, Global>, Global>>
[src]

Optional backtrace specified by a Vec of frames.

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

Return a raiseable sys::mrb_value.

impl RubyException for SyntaxError[src]

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

The exception’s message. Read more

pub fn name(&self) -> Cow<'_, str>[src]

The exception’s class name. Read more

impl Eq for SyntaxError[src]

impl StructuralEq for SyntaxError[src]

impl StructuralPartialEq for SyntaxError[src]

Auto Trait Implementations

impl RefUnwindSafe for SyntaxError

impl Send for SyntaxError

impl Sync for SyntaxError

impl Unpin for SyntaxError

impl UnwindSafe for SyntaxError

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
    T: Display + ?Sized
[src]

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 
[src]

pub fn vzip(self) -> V[src]