Struct Query

pub struct Query<'a> { /* private fields */ }

A query builder for retrieving papers from the database.

This struct provides a fluent interface for constructing paper queries, supporting various search criteria and result ordering options. It handles:

• Query criteria specification
• Result ordering configuration
• SQL generation and execution
• Paper reconstruction from rows

Implementations

impl<'a> Query<'a>

pub fn new(criteria: QueryCriteria<'a>) -> Self

Creates a new query with the given criteria.

Arguments

• criteria - The search criteria to use

Examples

let query = Query::new(QueryCriteria::All);

pub fn text(query: &'a str) -> Self

Creates a full-text search query.

Searches through paper titles and abstracts using SQLite’s FTS5 full-text search engine with wildcard matching.

Arguments

• query - The text to search for

Examples

let query = Query::text("quantum computing");

pub fn by_paper(paper: &'a Paper) -> Self

Creates a query to find a specific paper.

Arguments

• paper - The paper whose source and identifier should be matched

Examples

let learner = Learner::builder().build().await?;
let paper = learner.retriever.get_paper("2301.07041").await?;
let query = Query::by_paper(&paper);

pub fn by_source(source: &'a str, identifier: &'a str) -> Self

Creates a query to find a paper by its source and identifier.

Arguments

• source - The paper source (arXiv, DOI, etc.)
• identifier - The source-specific identifier

Examples

let query = Query::by_source("arxiv", "2301.07041");

pub fn by_author(name: &'a str) -> Self

Creates a query to find papers by author name.

Performs a partial match on author names, allowing for flexible name searches.

Arguments

• name - The author name to search for

Examples

let query = Query::by_author("Alice Researcher");

pub fn list_all() -> Self

Creates a query that returns all papers.

Examples

let query = Query::list_all();

pub fn before_date(date: DateTime<Utc>) -> Self

Creates a query for papers published before a specific date.

Arguments

• date - The cutoff date for publication

Examples

let date = DateTime::parse_from_rfc3339("2024-01-01T00:00:00Z").unwrap().with_timezone(&Utc);
let query = Query::before_date(date);

pub fn order_by(self, field: OrderField) -> Self

Sets the field to order results by.

Arguments

• field - The field to sort by

Examples

let query = Query::list_all().order_by(OrderField::PublicationDate);

pub fn descending(self) -> Self

Sets the order to descending (default is ascending).

Examples

let query = Query::list_all().order_by(OrderField::PublicationDate).descending();

Trait Implementations

impl DatabaseInstruction for Query<'_>

type Output = Vec<Paper>

The type returned by executing this instruction.

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, db: &'life1 mut Database, ) -> Pin<Box<dyn Future<Output = Result<Self::Output>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Executes the instruction against a database connection.

impl<'a> Debug for Query<'a>

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

Formats the value using the given formatter.