Struct lenient_semver::Error

pub struct Error<'input> { /* fields omitted */ }

Possible errors that happen during parsing and the location of the token where the error occurred.

Example

use semver::Version;

let error = lenient_semver::parse("1+").unwrap_err();
assert_eq!(error.to_string(), "Could not parse the build identifier: No input");

let error = lenient_semver::parse("1!").unwrap_err();
assert_eq!(error.to_string(), "Unexpected `!`");

Implementations

impl<'input> Error<'input>

pub fn owned(&self) -> OwnedError

Creates a new OwnedError out of this Error.

This is specialized version of Clone which returns a different type.

pub fn input(&self) -> &'input str

Returns the original input line.

Examples

let error = lenient_semver::parse("1+").unwrap_err();
assert_eq!(error.input(), "1+");

pub fn error_span(&self) -> Range<usize>

Returns range into the input string that points to the erroneous input.

Examples

let error = lenient_semver::parse("1+").unwrap_err();
assert_eq!(error.error_span(), 1..2);

pub fn error_kind(&self) -> ErrorKind

Returns the kind of error.

Examples

assert_eq!(
    lenient_semver::parse("").unwrap_err().error_kind(),
    lenient_semver::ErrorKind::MissingMajorNumber
);
assert_eq!(
    lenient_semver::parse("1.").unwrap_err().error_kind(),
    lenient_semver::ErrorKind::MissingMinorNumber
);
assert_eq!(
    lenient_semver::parse("1.2.").unwrap_err().error_kind(),
    lenient_semver::ErrorKind::MissingPatchNumber
);
assert_eq!(
    lenient_semver::parse("1-").unwrap_err().error_kind(),
    lenient_semver::ErrorKind::MissingPreRelease
);
assert_eq!(
    lenient_semver::parse("1+").unwrap_err().error_kind(),
    lenient_semver::ErrorKind::MissingBuild
);
assert_eq!(
    lenient_semver::parse("1!").unwrap_err().error_kind(),
    lenient_semver::ErrorKind::UnexpectedInput
);

pub fn erroneous_input(&self) -> &'input str

Returns a slice from the original input line that triggered the error.

Examples

let error = lenient_semver::parse("1+").unwrap_err();
assert_eq!(error.erroneous_input(), "+");

pub fn error_line(&self) -> String

Returns a text representation of the error.

Examples

let error = lenient_semver::parse("1.").unwrap_err();
assert_eq!(error.error_line(), String::from("Could not parse the minor identifier: No input"));

This is equivalent to the Display implementation, which can be further customized with format specifiers.

let error = lenient_semver::parse("1?").unwrap_err();
assert_eq!(format!("{:!^42}", error), String::from("!!!!!!!!!!!!!!Unexpected `?`!!!!!!!!!!!!!!"));

pub fn indicate_erroneous_input(&self) -> String

Returns a caret line indication the erroneous input if it was written under the original input line.

Examples

let error = lenient_semver::parse("foo").unwrap_err();
assert_eq!(error.indicate_erroneous_input(), "^^^");

let error = lenient_semver::parse("1.2.3 bar").unwrap_err();
assert_eq!(error.indicate_erroneous_input(), "~~~~~~^^^");

Trait Implementations

impl<'input> Debug for Error<'input>

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

Formats the value using the given formatter.

impl<'_> Display for Error<'_>

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

Formats the value using the given formatter.

impl<'input> Eq for Error<'input>

impl<'_> Error for Error<'_>

fn source(&self) -> Option<&(dyn Error + 'static)>

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

fn backtrace(&self) -> Option<&Backtrace>

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

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

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

impl<'input> PartialEq<Error<'input>> for Error<'input>

fn eq(&self, other: &Error<'input>) -> bool

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

fn ne(&self, other: &Error<'input>) -> bool

This method tests for !=.

impl<'input> StructuralEq for Error<'input>

impl<'input> StructuralPartialEq for Error<'input>