Struct crossref::CrossrefBuilder

pub struct CrossrefBuilder { /* fields omitted */ }

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

Example

use crossref::Crossref;

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

Methods

impl CrossrefBuilder

pub fn new() -> CrossrefBuilder

Constructs a new CrossrefBuilder.

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

pub fn polite(self, email: &str) -> Self

be polite and set your email as User-Agent will get you in the polite pool of crossref

pub fn user_agent(self, user_agent: &str) -> Self

set the user agent directly

pub fn token(self, token: &str) -> Self

set a crossref plus service API token

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

impl Default for CrossrefBuilder

fn default() -> CrossrefBuilder

Returns the "default value" for a type.