Struct core_api_client::SearchQuery

pub struct SearchQuery<T1 = String, T2 = String>
where
    T1: ToString,
    T2: ToString,
{ /* private fields */ }

SearchQuery is a structure that represents a search query to the API. It allows the user to define the criteria to filter data from the API.

SearchQuery contains various search parameters such as limit, offset, scroll and stats that can be optionally set for advanced search operations.

A search operation can be composed of multiple Filter conditions that can be linked using logical AND/OR operators. Each Filter condition consists of a FilterOperator that defines the type of comparison to be made.

Example

use core_api_client::FilterOperator;
use core_api_client::Api;
 
let api = Api::from("API_KEY");
 
let query = api.paged_search(10, 0)
   .and(FilterOperator::Exists("doi"))
   .and(FilterOperator::Bigger("citationCount", 20));
 
let resp = api.search_works(query);

Fields

• filters: A vector of Filter structs that represent the conditions of the search query.
• limit: The maximum number of results to return. Defaults to None.
• offset: The number of results to skip before starting to fetch. Defaults to None.
• scroll: Enable/disable the scrolling functionality. Defaults to None.
• stats: Enable/disable the statistics functionality. Defaults to None.

Methods

• and: Adds a new filter condition with a logical AND operator.
• or: Adds a new filter condition with a logical OR operator.
• parse: Parses the SearchQuery object into a string to be used in the API request.

Implementations

impl<T1, T2> SearchQuery<T1, T2>

where T1: ToString, T2: ToString,

pub fn and(self, operator: FilterOperator<T1, T2>) -> Self

Adds a filter to the SearchQuery with an AND logical operator.

Arguments

• operator: FilterOperator<T1, T2> - The filter operator and its associated values to be added to the search query.

Example

use core_api_client::{Api, SearchQuery, FilterOperator};
 
let api = Api::from("API_KEY");
let query = api.paged_search(10, 0)
    .and(FilterOperator::Exists("doi"))
    .and(FilterOperator::Bigger("citationCount", 20));

pub fn or(self, operator: FilterOperator<T1, T2>) -> Self

Adds a filter to the SearchQuery with an OR logical operator.

Arguments

• operator: FilterOperator<T1, T2> - The filter operator and its associated values to be added to the search query.

Example

use core_api_client::{Api, SearchQuery, FilterOperator};
 
let api = Api::from("API_KEY");
let query = api.paged_search(10, 0)
    .or(FilterOperator::Exists("doi"))
    .or(FilterOperator::Bigger("citationCount", 20));

pub fn parse(self) -> String

Converts the SearchQuery instance into a string that represents a valid URL query string.

This method concatenates all added filters with their corresponding logical operators, and includes additional parameters like limit, offset, scroll and stats, if they are present.

Returns

• String - The resulting URL query string.

Example

use core_api_client::{Api, SearchQuery, FilterOperator};
 
let api = Api::from("API_KEY");
let query = api.paged_search(10, 0)
    .and(FilterOperator::Eq("publisher", "OJS"));

assert_eq!("?limit=10&offset=0&q=%20AND%20publisher=OJS".to_string(), query.parse());

Trait Implementations

impl<T1, T2> Clone for SearchQuery<T1, T2>

where T1: ToString + Clone, T2: ToString + Clone,

fn clone(&self) -> SearchQuery<T1, T2>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T1, T2> Debug for SearchQuery<T1, T2>

where T1: ToString + Debug, T2: ToString + Debug,

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

Formats the value using the given formatter.

impl<T1, T2> Default for SearchQuery<T1, T2>

where T1: ToString + Default, T2: ToString + Default,

fn default() -> SearchQuery<T1, T2>

Returns the “default value” for a type.

impl<'de, T1, T2> Deserialize<'de> for SearchQuery<T1, T2>

where T1: ToString + Deserialize<'de>, T2: ToString + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T1, T2> Display for SearchQuery<T1, T2>

where T1: ToString, T2: ToString,

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

Formats the value using the given formatter.

impl<T1, T2> Hash for SearchQuery<T1, T2>

where T1: ToString + Hash, T2: ToString + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T1, T2> PartialEq for SearchQuery<T1, T2>

where T1: ToString + PartialEq, T2: ToString + PartialEq,

fn eq(&self, other: &SearchQuery<T1, T2>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T1, T2> PartialOrd for SearchQuery<T1, T2>

where T1: ToString + PartialOrd, T2: ToString + PartialOrd,

fn partial_cmp(&self, other: &SearchQuery<T1, T2>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2> Serialize for SearchQuery<T1, T2>

where T1: ToString + Serialize, T2: ToString + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T1, T2> StructuralPartialEq for SearchQuery<T1, T2>

where T1: ToString, T2: ToString,