Struct ArticleQuery 

pub struct ArticleQuery {

    pub search_for: Option<String>,
    pub published_since: Option<String>,
    pub modified_since: Option<String>,
    pub institution: Option<u64>,
    pub group: Option<u64>,
    pub item_type: Option<DefinedType>,
    pub resource_doi: Option<String>,
    pub doi: Option<String>,
    pub handle: Option<String>,
    pub project_id: Option<u64>,
    pub resource_title: Option<String>,
    pub order: Option<ArticleOrder>,
    pub order_direction: Option<OrderDirection>,
    pub page: Option<u64>,
    pub page_size: Option<u64>,
    pub offset: Option<u64>,
    pub limit: Option<u64>,
    pub custom: Vec<(String, String)>,
}

Shared query options for public and authenticated article list/search calls.

Fields

search_for: Option<String>

Search string used by POST .../search endpoints.

published_since: Option<String>

Filter results published since the given ISO-8601 string.

modified_since: Option<String>

Filter results modified since the given ISO-8601 string.

institution: Option<u64>

Restrict results to the given institution.

group: Option<u64>

Restrict results to the given group.

item_type: Option<DefinedType>

Restrict results to the given item type.

resource_doi: Option<String>

Restrict results to the given resource DOI.

doi: Option<String>

Restrict results to the given DOI.

handle: Option<String>

Restrict results to the given handle.

project_id: Option<u64>

Restrict results to the given project.

resource_title: Option<String>

Legacy resource title filter retained for backward-compatibility checks.

order: Option<ArticleOrder>

Optional sort field.

order_direction: Option<OrderDirection>

Optional sort direction.

page: Option<u64>

Page number based pagination.

page_size: Option<u64>

Page size based pagination.

offset: Option<u64>

Offset based pagination.

limit: Option<u64>

Limit based pagination.

custom: Vec<(String, String)>

Extra raw key-value pairs forwarded as-is.

Implementations

impl ArticleQuery

pub fn builder() -> ArticleQueryBuilder

Starts building a query.

Examples

use figshare_rs::{ArticleOrder, ArticleQuery, DefinedType, OrderDirection};

let query = ArticleQuery::builder()
    .item_type(DefinedType::Dataset)
    .doi("10.6084/m9.figshare.123")
    .order(ArticleOrder::PublishedDate)
    .order_direction(OrderDirection::Desc)
    .limit(10)
    .build();

assert_eq!(query.item_type, Some(DefinedType::Dataset));
assert_eq!(query.doi.as_deref(), Some("10.6084/m9.figshare.123"));
assert_eq!(query.limit, Some(10));

Trait Implementations

impl Clone for ArticleQuery

fn clone(&self) -> ArticleQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArticleQuery

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

Formats the value using the given formatter.

impl Default for ArticleQuery

fn default() -> ArticleQuery

Returns the “default value” for a type.

impl PartialEq for ArticleQuery

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for ArticleQuery

impl StructuralPartialEq for ArticleQuery