Skip to main content

WorksQuery

Struct WorksQuery 

Source
pub struct WorksQuery {
    pub free_form_queries: Vec<String>,
    pub field_queries: Vec<FieldQuery>,
    pub filter: Vec<WorksFilter>,
    pub sort: Option<Sort>,
    pub order: Option<Order>,
    pub elements: Vec<WorkElement>,
    pub facets: Vec<FacetCount>,
    pub result_control: Option<WorkResultControl>,
    pub sample: Option<usize>,
}
Expand description

Used to construct a query that targets crossref Works elements

§Example

use crossref_client::{Order, WorksQuery};

// create a new query for topcis machine+learning ordered desc
let query = WorksQuery::new("machine learning").order(Order::Desc);

Each query parameter is ANDed

Fields§

§free_form_queries: Vec<String>

search by non specific query

§field_queries: Vec<FieldQuery>

match only particular fields of metadata

§filter: Vec<WorksFilter>

filter to apply while querying

§sort: Option<Sort>

sort results by a certain field and

§order: Option<Order>

set the sort order to asc or desc

§elements: Vec<WorkElement>

elements to return

§facets: Vec<FacetCount>

enable facet information in responses

§result_control: Option<WorkResultControl>

deep page through /works result sets

§sample: Option<usize>

request random dois if set all other parameters are ignored

Implementations§

Source§

impl WorksQuery

Source

pub fn empty() -> Self

alias for creating an empty default element

Source

pub fn random(len: usize) -> Self

creates an new WorksQuery with the desired sample size that will result in a request for random dois

Source

pub fn new<T: ToString>(query: T) -> Self

Convenience method to create a new WorksQuery with a term directly

Source

pub fn sample(self, len: impl Into<Option<usize>>) -> Self

Ask for len random works instead of a search, or for a search if given None. Crossref ignores every other parameter when it is set.

Source

pub fn query<T: ToString>(self, query: T) -> Self

add a new free form query

Source

pub fn queries<T: ToString>(self, queries: &[T]) -> Self

Create a new query for the topics renear+ontologies

§Example
use crossref_client::WorksQuery;

let query = WorksQuery::default().queries(&["renear", "ontologies"]);

add a bunch of free form query terms

Source

pub fn field_query(self, query: FieldQuery) -> Self

add a new field query form query

Source

pub fn elements(self, element: Vec<WorkElement>) -> Self

Narrow the response to the given fields.

Crossref returns only what is selected, so every field left out is None on the resulting Work.

WorkElement::DOI is always sent, whether or not it is asked for: it is the one field Work requires, so a response without it could not be read back at all.

Source

pub fn field_queries(self, queries: Vec<FieldQuery>) -> Self

use crossref_client::{FieldQuery,WorksQuery};

let query = WorksQuery::default().field_queries(vec![FieldQuery::title("room at the bottom"), FieldQuery::author("richard feynman")]);

add a bunch of free form query terms

Source

pub fn filter(self, filter: WorksFilter) -> Self

add a new filter to the query

Source

pub fn sort(self, sort: impl Into<Option<Sort>>) -> Self

Sort the results by a field, or by relevance if given None.

Source

pub fn order(self, order: impl Into<Option<Order>>) -> Self

Order the results, or leave the order to crossref if given None.

Source

pub fn facet(self, facet: FacetCount) -> Self

add another facet to query

Source

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

set the cursor for result control deep paging

Source

pub fn new_cursor(self) -> Self

set an empty cursor

Source

pub fn result_control( self, result_control: impl Into<Option<WorkResultControl>>, ) -> Self

Limit the results, or take crossref’s default page if given None.

Source

pub fn into_combined<W: WorksCombiner>(self, id: &str) -> W

Wrap the query in a combined query.

§Example

Create a Funders Query that targets all works of a funder with id funder id.

let funders: Funders = WorksQuery::default().into_combined("funder id");
Source

pub fn into_ident(self, id: &str) -> WorksIdentQuery

Bind the query to a specific id of a primary endpoint element

Source

pub fn into_combined_query<W: WorksCombiner>(self, id: &str) -> WorkListQuery

wrap this query in new WorkListQuery that targets the /works route of a primary component with an id. The query will evaluate to the same as WorksQuery::into_combined

§Example

Create a query that targets all Works of a funder with id funder id

let query = WorksQuery::default()
    .into_combined_query::<Funders>("funder id");

Trait Implementations§

Source§

impl Clone for WorksQuery

Source§

fn clone(&self) -> Self

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 CrossrefRoute for WorksQuery

Source§

fn route(&self) -> Result<String>

constructs the route for the crossref api
Source§

impl Debug for WorksQuery

Source§

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

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

impl Default for WorksQuery

Source§

fn default() -> Self

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

impl From<WorksQuery> for WorkListQuery

Source§

fn from(val: WorksQuery) -> Self

Converts to this type from the input type.

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.

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

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