Skip to main content

PaperSearchQuery

Struct PaperSearchQuery 

Source
pub struct PaperSearchQuery {
    pub query: String,
    pub limit: usize,
    pub from_year: Option<i32>,
    pub to_year: Option<i32>,
    pub oa_only: bool,
    pub min_citations: Option<u64>,
    pub min_fwci: Option<f64>,
    pub min_percentile: Option<u8>,
    pub author: Option<String>,
    pub venue: Option<String>,
    pub publisher: Option<String>,
    pub sort: SearchSort,
}
Expand description

A discovery-search request: the free-text query plus triage filters.

Construct directly (all fields are public); the CLI maps its flags onto this.

Fields§

§query: String

Free-text topic query (e.g. “tropical tensor networks for spin glasses”). Must be non-empty; the caller is expected to reject empty input.

§limit: usize

Maximum number of results to return, bounded to 1..=200 (OpenAlex per-page ceiling). validate rejects an out-of-range value; paper_search itself only clamps it as defense-in-depth (see the function’s caller-side-validation note).

§from_year: Option<i32>

Inclusive lower bound on publication year (maps to OpenAlex from_publication_date:<year>-01-01).

§to_year: Option<i32>

Inclusive upper bound on publication year (maps to OpenAlex to_publication_date:<year>-12-31).

§oa_only: bool

When true, restrict to open-access works (is_oa:true).

§min_citations: Option<u64>

Minimum citation count. Maps to OpenAlex cited_by_count:>{n} (“more than n”); the off-by-one versus “at least n” is documented on the CLI flag.

§min_fwci: Option<f64>

Minimum field-and-year-normalized citation impact (FWCI). Maps to OpenAlex fwci:>{f} — an impact floor that, unlike sorting by citations, narrows the set without overriding relevance (#290).

§min_percentile: Option<u8>

Minimum within-cohort citation percentile (0–100). Maps to OpenAlex cited_by_percentile_year.min:{p} — “top-X% among same-year works”; combined with from_year this is the “recent × already standing out” set (#290).

§author: Option<String>

Author name to filter by. Resolved to an OpenAlex author ID via /authors?search= then applied as authorships.author.id.

§venue: Option<String>

Venue / journal name to filter by. Resolved to an OpenAlex source ID via /sources?search= then applied as primary_location.source.id.

§publisher: Option<String>

Publisher name to filter by. Resolved to an OpenAlex publisher ID via /publishers?search= then applied as primary_location.source.publisher_lineage.

§sort: SearchSort

Result ordering.

Implementations§

Source§

impl PaperSearchQuery

Source

pub fn new(query: impl Into<String>) -> Self

A bare query with DEFAULT_LIMIT, no filters, relevance sort.

Source

pub fn validate(&self) -> Result<(), String>

Validate the request shape, returning a human-readable message on the first problem. This is the single source of truth for the boundary validation that both the CLI and the MCP tool apply (paper_search itself stays permissive — see its docs); keeping it here prevents the two surfaces from drifting.

Checks: non-empty query, limit in 1..=MAX_PER_PAGE, a non-inverted from_year/to_year range, a finite non-negative min_fwci, and a min_percentile in 0..=100.

§Errors

Err(msg) describing the first invalid field; msg is suitable for surfacing directly to a user / agent.

Trait Implementations§

Source§

impl Clone for PaperSearchQuery

Source§

fn clone(&self) -> PaperSearchQuery

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 Debug for PaperSearchQuery

Source§

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

Formats the value using the given formatter. 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> 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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

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
§

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> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more