Struct CsvDecodeError 

pub struct CsvDecodeError { /* private fields */ }

An error from decoding a CSV record into a typed value.

Carries a stable kind, a human-readable message, and the 0-based record/field indices when known.

Implementations

impl CsvDecodeError

pub const fn new(kind: CsvDecodeErrorKind, message: &'static str) -> Self

Creates a decode error with a stable kind and an actionable message.

pub const fn field_count() -> Self

A record had the wrong number of fields for the target type. The offending location is reported through the record/field indices rather than the message, which stays a stable &'static str.

Examples found in repository

examples/basic.rs (line 32)

    fn decode_fields(fields: &[&str]) -> Result<Self, CsvDecodeError> {
        if fields.len() != 3 {
            return Err(CsvDecodeError::field_count());
        }
        Ok(Service {
            name: String::decode_field(fields[0]).map_err(|e| e.at_field(0))?,
            port: u16::decode_field(fields[1]).map_err(|e| e.at_field(1))?,
            enabled: bool::decode_field(fields[2]).map_err(|e| e.at_field(2))?,
        })
    }

pub const fn field(message: &'static str) -> Self

A field could not be parsed into the target type.

pub const fn header_mismatch() -> Self

The header row did not match the target’s expected header.

pub const fn kind(&self) -> CsvDecodeErrorKind

Returns the stable error category.

pub const fn message(&self) -> &'static str

Returns a human-readable message.

pub const fn record(&self) -> Option<usize>

The 0-based record index where the error occurred, if known.

pub const fn field_index(&self) -> Option<usize>

The 0-based field index where the error occurred, if known.

pub const fn at_record(self, record: usize) -> Self

Attaches the 0-based record index to this error.

pub const fn at_field(self, field: usize) -> Self

Attaches the 0-based field index to this error.

Examples found in repository

examples/basic.rs (line 35)

    fn decode_fields(fields: &[&str]) -> Result<Self, CsvDecodeError> {
        if fields.len() != 3 {
            return Err(CsvDecodeError::field_count());
        }
        Ok(Service {
            name: String::decode_field(fields[0]).map_err(|e| e.at_field(0))?,
            port: u16::decode_field(fields[1]).map_err(|e| e.at_field(1))?,
            enabled: bool::decode_field(fields[2]).map_err(|e| e.at_field(2))?,
        })
    }

Trait Implementations

impl Clone for CsvDecodeError

fn clone(&self) -> CsvDecodeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CsvDecodeError

impl Debug for CsvDecodeError

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

Formats the value using the given formatter.

impl Display for CsvDecodeError

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

Formats the value using the given formatter.

impl Eq for CsvDecodeError

impl Error for CsvDecodeError

Available on crate feature std only.

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 From<CsvDecodeError> for CsvFromStrError

fn from(error: CsvDecodeError) -> Self

Converts to this type from the input type.

impl PartialEq for CsvDecodeError

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