Struct ParseError 

pub struct ParseError { /* private fields */ }

Why a value was refused, and where.

Eight bytes, Copy, and it never contains input bytes, so it is safe to log.

Examples

use parse_net::{ErrorKind, ParseError};

let err = ParseError::new(ErrorKind::InvalidByte, 4);
assert_eq!(err.kind(), ErrorKind::InvalidByte);
assert_eq!(err.offset(), 4);
assert_eq!(err.to_string(), "invalid byte at offset 4");
assert_eq!(core::mem::size_of::<ParseError>(), 8);

Implementations

impl ParseError

pub const fn new(kind: ErrorKind, offset: usize) -> Self

Builds an error of kind at byte offset.

For callers that implement a visitor or wrap parse-net. Offsets above u32::MAX saturate.

Examples

use parse_net::{ErrorKind, ParseError};

let e = ParseError::new(ErrorKind::TooLong, 12);
assert_eq!((e.kind(), e.offset(), e.line()), (ErrorKind::TooLong, 12, 0));
assert_eq!(ParseError::new(ErrorKind::TooLong, usize::MAX).offset(), u32::MAX as usize);

pub const fn kind(&self) -> ErrorKind

What was refused.

Examples

use parse_net::ErrorKind;

let e = parse_net::list(b"a, \"b").unwrap_err();
assert_eq!(e.kind(), ErrorKind::UnterminatedQuote);

pub const fn offset(&self) -> usize

The offset of the first byte that could not be accepted, relative to the start of the value passed in, or of the field line named by line when several lines were parsed as one field.

Examples

use parse_net::ErrorKind;

let e = parse_net::list(b"gzip, b\x01r").unwrap_err();
assert_eq!((e.kind(), e.offset()), (ErrorKind::Control, 7));

pub const fn line(&self) -> usize

The zero-based index of the field line that failed when several lines were parsed as one field; 0 otherwise. Saturates at 255.

Examples

use parse_net::{list, ErrorKind, Limits};

let lines: [&[u8]; 3] = [b"gzip", b"br", b"x\x00"];
let e = list::combined(lines, &Limits::DEFAULT).unwrap_err();
assert_eq!((e.kind(), e.line(), e.offset()), (ErrorKind::Nul, 2, 1));

Trait Implementations

impl Clone for ParseError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ParseError

impl Debug for ParseError

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

Formats the value using the given formatter.

impl Display for ParseError

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

Formats the value using the given formatter.

impl Eq for ParseError

impl Error for ParseError

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

Returns the lower-level source of this error, if any.

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

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.

impl Hash for ParseError

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 PartialEq for ParseError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ParseError