Skip to main content

Error

Enum Error 

Source
#[non_exhaustive]
pub enum Error { UnprefixedIdentifier { given: String, }, InvalidIdentifier { given: String, why: &'static str, }, InvalidOci { given: String, why: &'static str, }, NoSuchOperation { message: String, }, Api { status: u16, body: String, }, RateLimited { attempts: u32, }, Malformed { what: &'static str, source: Error, }, ReqWest { reqwest: Error, }, Config { msg: String, }, }
Expand description

Everything that can go wrong talking to OpenCitations.

Note what is not here: an identifier OpenCitations holds nothing about is not an error. Both apis answer such a request with 200 and an empty list, so a lookup that found nothing comes back as an empty Vec and a count of zero. See Error::NoSuchOperation for the case that does fail.

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.
§

UnprefixedIdentifier

an identifier that is not scheme:value

OpenCitations addresses everything by a prefixed identifier – a bare 10.1016/j.marpol.2021.104855 means nothing to it, doi: in front of it does. The prefix is required here rather than guessed at, because a guess that picks the wrong scheme is answered with an empty list and reads exactly like a work nobody has cited.

Fields

§given: String

the identifier as it was written

§

InvalidIdentifier

an identifier whose scheme or value is empty, e.g. doi: or :10.1016

Fields

§given: String

the identifier as it was written

§why: &'static str

what is wrong with it

§

InvalidOci

a string that is not an Open Citation Identifier

An OCI is the two OMIDs of the citing and cited work joined by a -, e.g. 06024047477-06220256775.

Fields

§given: String

the identifier as it was written

§why: &'static str

what is wrong with it

§

NoSuchOperation

OpenCitations answered a route it does not serve

Answered with a 404 and a plain-text body rather than json, which is what an identifier it could not even parse produces – citations/foo rather than citations/doi:foo.

Fields

§message: String

the body it answered with, trimmed

§

Api

OpenCitations refused the request

The body is passed through as it arrived, because it is sometimes json and sometimes plain text and neither shape is documented.

Fields

§status: u16

the status it answered with

§body: String

the body it answered with, trimmed

§

RateLimited

OpenCitations kept answering 429 until the retry budget ran out

The client paces itself well inside the documented 180 requests a minute, so this normally means requests are also being made from somewhere else on the same address – another process, or another OpenCitations built separately rather than cloned.

Fields

§attempts: u32

how many times the request was sent

§

Malformed

a response this crate could not read

Every field of both apis arrives as a string, including the ones that are plainly numbers and dates, so this is where an unannounced change of shape surfaces.

Fields

§what: &'static str

which part of the response was unreadable

§source: Error

the underlying deserialization error

§

ReqWest

an error that occurred while operating with reqwest

Fields

§reqwest: Error

the underlying transport error

§

Config

the client could not be built

Fields

§msg: String

what could not be configured

Trait Implementations§

Source§

impl Debug for Error

Source§

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

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

impl Display for Error

Source§

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

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

impl Error for Error

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 From<Error> for Error

Source§

fn from(source: Error) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Error

§

impl !UnwindSafe for Error

§

impl Freeze for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more