Skip to main content

CrossrefBuilder

Struct CrossrefBuilder 

Source
pub struct CrossrefBuilder { /* private fields */ }
Expand description

A CrossrefBuilder can be used to create Crossref with additional config.

§Example

use crossref_client::Crossref;

let client = Crossref::builder()
    .polite("polite@example.com")
    .token("your token")
    .build()?;

Every setter accepts Option, so options that are themselves optional – a CLI flag, a config field – can be passed straight through:

let client = Crossref::builder().polite(email.as_deref()).build()?;

Implementations§

Source§

impl CrossrefBuilder

Source

pub fn new() -> CrossrefBuilder

Constructs a new CrossrefBuilder.

This is the same as Crossref::builder().

Source

pub fn polite<'a>(self, email: impl Into<Option<&'a str>>) -> Self

Be polite: identify yourself by email and get routed to crossref’s polite pool.

Sends a User-Agent in the shape crossref asks for, e.g. crossref-client/0.2.0 (https://github.com/…; mailto:you@example.com). Anonymous requests share a rate-limited pool and are the usual cause of 429 responses; check where you landed with Crossref::api_pool.

Use CrossrefBuilder::user_agent instead if you want to send your own application’s name; include mailto:<email> in it to stay in the pool.

Source

pub fn user_agent<'a>(self, user_agent: impl Into<Option<&'a str>>) -> Self

set the user agent directly

Source

pub fn token<'a>(self, token: impl Into<Option<&'a str>>) -> Self

set a crossref plus service API token

Source

pub fn base_url<'a>(self, base_url: impl Into<Option<&'a str>>) -> Self

Send requests somewhere other than https://api.crossref.org.

Routes are appended verbatim, so the url must not end in a /. Mainly useful for pointing the client at a mock or a proxy in tests.

Source

pub fn rate_limit(self, rate_limit: impl Into<Option<RateLimit>>) -> Self

The request budget to assume until crossref reports its own.

Defaults to RateLimit::CONSERVATIVE. Crossref sends the real budget on every response and the client follows it from then on, so this only paces the first few requests.

Source

pub fn max_retries(self, max_retries: impl Into<Option<u32>>) -> Self

How many times a 429 is retried before giving up with Error::RateLimited. Defaults to 3; 0 disables retrying.

Source

pub fn build(self) -> Result<Crossref>

Returns a Crossref that uses this CrossrefBuilder configuration.

§Errors

This will fail if TLS backend cannot be initialized see reqwest::ClientBuilder::build

Trait Implementations§

Source§

impl Debug for CrossrefBuilder

Source§

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

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

impl Default for CrossrefBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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, 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