Struct Error

pub struct Error { /* private fields */ }

A parse error.

This is a wrapper type for a Pest Error to make it easier to work with and report within Sprocket.

Implementations

impl Error

pub fn new(message: impl Into<String>, location: Location) -> Self

Creates a new parse Error.

Note: almost always, you should prefer converting from a Pest error to an Error using Error::from(). Don’t use this function unless you know what you are doing!

Examples

use wdl_core::concern::parse;
use wdl_core::file::Location;

let error = parse::Error::new("Hello, world!", Location::Unplaced);

pub fn message(&self) -> &str

Gets the message from the Error by reference.

Examples

use wdl_core::concern::parse;
use wdl_core::file::Location;

let error = parse::Error::new("Hello, world!", Location::Unplaced);
assert_eq!(error.message(), "Hello, world!");

pub fn into_message(self) -> String

Consumes self and returns the message for this Error.

Examples

use wdl_core::concern::parse;
use wdl_core::file::Location;

let error = parse::Error::new("Hello, world!", Location::Unplaced);
assert_eq!(error.into_message(), String::from("Hello, world!"));

pub fn byte_range(&self) -> Option<Range<usize>>

Gets the byte range from the Error by reference.

Examples

use wdl_core::concern::parse;
use wdl_core::file::Location;

let error = parse::Error::new("Hello, world!", Location::Unplaced);
assert_eq!(error.byte_range(), None);

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Error

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Error

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

Formats the value using the given formatter.

impl<R: RuleType> From<Error<R>> for Error

fn from(err: Error<R>) -> Self

Converts to this type from the input type.

impl Hash for Error

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Error

fn cmp(&self, other: &Error) -> 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 Error

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

fn partial_cmp(&self, other: &Error) -> 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 Serialize for Error

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Error

impl StructuralPartialEq for Error