Skip to main content

MetadataOnlyOptions

Struct MetadataOnlyOptions 

Source
#[non_exhaustive]
pub struct MetadataOnlyOptions { pub include_oa_location: bool, }
Expand description

What a metadata-only resolve may spend beyond its single round-trip.

One knob, and it exists because #517 removed the reason there was none. The DOI path is Crossref-first, and its rationale was that Crossref’s message.link[] supplied an OA URL for free. Measurement showed every entry is programme-scoped, so extract_crossref_publisher_url correctly returns None for every DOI – leaving oa_url permanently null while docs/MCP_TOOLS.md s11 told callers to act on it (#539).

Crossref-first is still the right default: it resolves nearly every DOI in one request. What was wrong was promising a field it cannot fill. So the caller says whether it wants the second request.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§include_oa_location: bool

Consult Unpaywall for a real OA location, filling oa_url, oa_status and license from its record.

Costs one extra request against Unpaywall. Unpaywall is a metadata source, so this does not weaken the “never fetches a PDF, never touches a publisher” guarantee: the URL is still reported and never followed.

Off by default. A caller that wants metadata should not pay for a location it will not use.

§Reading the result

With this set, the oa_status/oa_url pair says which of three things happened:

oa_statusoa_urlmeaning
"closed"Noneasked; this work has no OA location
"gold", "green", …Someasked; here it is
NoneNonethe lookup did not complete

The third row is why a failed Unpaywall call leaves both fields None rather than filling in a plausible-looking oa_status: a caller that paid for a lookup has to be able to tell “no OA location exists” from “I could not find out”, and that distinction is the whole of #539.

Implementations§

Source§

impl MetadataOnlyOptions

Source

pub const fn with_oa_location(self, include: bool) -> Self

Ask for the OA location (or not).

A builder rather than a struct literal because the struct is #[non_exhaustive]: a future option must not be a breaking change for doiget-mcp, doiget-cli, or anyone else downstream.

Trait Implementations§

Source§

impl Clone for MetadataOnlyOptions

Source§

fn clone(&self) -> MetadataOnlyOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for MetadataOnlyOptions

Source§

impl Debug for MetadataOnlyOptions

Source§

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

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

impl Default for MetadataOnlyOptions

Source§

fn default() -> MetadataOnlyOptions

Returns the “default value” for a type. Read more
Source§

impl Eq for MetadataOnlyOptions

Source§

impl PartialEq for MetadataOnlyOptions

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for MetadataOnlyOptions

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

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