Skip to main content

XbrlError

Enum XbrlError 

Source
#[non_exhaustive]
pub enum XbrlError { Malformed(Box<dyn StdError + Send + Sync + 'static>), NotXbrl(String), ValueConversion { field: String, concept: String, value: String, target_type: &'static str, }, }
Expand description

What can go wrong reading a document, or a struct from one.

The parser is lenient by design: real filings carry malformed HTML, unknown entities and unclosed tags, and it steps over all of those. An error here means the document could not be read at all.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Malformed(Box<dyn StdError + Send + Sync + 'static>)

The markup is broken at a point the parser cannot step over.

§

NotXbrl(String)

The document is well-formed, but it is not XBRL: an XML document with no <xbrl> root, say.

§

ValueConversion

A fact’s value does not convert to the type of the field bound to it: a filer tagging N/A under a numeric concept.

Document::extract fails on the first of these; Document::extract_lenient leaves the field empty and returns them alongside the struct.

Fields

§field: String

The struct field being filled.

§concept: String

The concept the value was tagged with, e.g. us-gaap:Assets.

§value: String

The value as the filing gives it, cut to 80 characters.

§target_type: &'static str

The Rust type of the field.

Trait Implementations§

Source§

impl Debug for XbrlError

Source§

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

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

impl Display for XbrlError

Source§

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

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

impl Error for XbrlError

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

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.