Skip to main content

PdfLegStatus

Enum PdfLegStatus 

Source
#[non_exhaustive]
pub enum PdfLegStatus { Fetched, NoOaUrl, Blocked { code: ErrorCode, message: String, denial: Option<DenialContext>, suggested_arxiv_id: Option<String>, }, }
Expand description

Outcome of a successful fetch_paper call.

Wire shape mirrors docs/MCP_TOOLS.md §5 FetchResult minus the envelope chrome the MCP server wraps it in (ok: true, ref, optional error).

path is the absolute path of the resource the orchestrator wrote to the store. For arXiv refs and successful DOI OA-PDF fetches this is <root>/<safekey>.pdf; for the DOI metadata-only fallback (OA URL host off the oa-publisher allowlist, or PDF leg failed for another transport reason — docs/REDIRECT_ALLOWLIST.md §3 informed-best- effort posture) this is <root>/.metadata/<safekey>.toml. Outcome of the DOI OA-PDF leg, carried on FetchPaperOutcome so a caller can NEVER silently report a blocked PDF as a plain “metadata-only” success (issue #118). The product promise is “immediately explain WHY a paper can’t be fetched” — the distinction between “there was no OA PDF to fetch” and “an OA PDF existed but we were blocked, and here is the reason” is exactly that explanation.

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

Fetched

A PDF was fetched and written to disk (arXiv always; DOI when the OA-publisher leg succeeded).

§

NoOaUrl

No OA URL was discovered (Unpaywall reported no best_oa_location). Metadata-only is the correct, expected result here — not a failure.

§

Blocked

An OA URL was discovered but the PDF could not be retrieved (host outside the oa-publisher allowlist, not-a-PDF body, transport failure, …). Metadata was still written, but the caller MUST surface this reason rather than pretending the fetch was a clean metadata-only success.

Fields

§code: ErrorCode

Closed-set code, mapped from the underlying transport error via the canonical From<FetchError> for ErrorCode.

§message: String

Human-readable one-line reason (the FetchError display).

§denial: Option<DenialContext>

Structured denial side-channel (ADR-0023) when the failure was an allowlist / scheme denial; None otherwise.

§suggested_arxiv_id: Option<String>

Actionable suggested arXiv ID for the same paper when Unpaywall metadata includes an arXiv alternative but the PDF leg was blocked.

Trait Implementations§

Source§

impl Clone for PdfLegStatus

Source§

fn clone(&self) -> PdfLegStatus

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PdfLegStatus

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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