Skip to main content

ParseError

Struct ParseError 

Source
pub struct ParseError;
Expand description

Error returned by <NHSNumber as FromStr>::from_str for any string that is not one of the two accepted shapes (see spec/05-string-forms.md §5).

ParseError is a unit struct — every error value compares equal:

use nhs_number::NHSNumber;
use nhs_number::parse_error::ParseError;
use std::str::FromStr;

let a = NHSNumber::from_str("not even close").unwrap_err();
let b = NHSNumber::from_str("wrong length").unwrap_err();
assert_eq!(a, b);
assert_eq!(a, ParseError);

To map it to your own richer error type:

use nhs_number::NHSNumber;
use std::str::FromStr;

#[derive(Debug, PartialEq)]
enum MyError {
    BadNhsNumber(String),
}

let bad = "not a number";
let result: Result<NHSNumber, MyError> =
    NHSNumber::from_str(bad).map_err(|_| MyError::BadNhsNumber(bad.into()));
assert_eq!(result, Err(MyError::BadNhsNumber("not a number".into())));

ParseError also implements Display and std::error::Error, so it flows through ? into boxed-error stacks without manual mapping:

use nhs_number::NHSNumber;
use std::error::Error;
use std::str::FromStr;

fn parse(s: &str) -> Result<NHSNumber, Box<dyn Error>> {
    Ok(NHSNumber::from_str(s)?)
}

assert!(parse("999 100 0003").is_ok());
assert!(parse("not a number").is_err());

Trait Implementations§

Source§

impl Debug for ParseError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ParseError

A fixed message with no input echo — the rejected candidate string must never leak into error messages or logs (see AGENTS/safety.md §3).

use nhs_number::parse_error::ParseError;

assert_eq!(ParseError.to_string(), "invalid NHS Number string");
Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ParseError

Source§

impl Error for ParseError

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl PartialEq for ParseError

Source§

fn eq(&self, other: &ParseError) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ParseError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.