CrossRefClient

Struct CrossRefClient 

Source
pub struct CrossRefClient { /* private fields */ }
Expand description

Client for CrossRef.org scholarly publication API

Provides methods to search for publications, filter by various criteria, and convert results to SemanticVector format for RuVector analysis.

§Rate Limiting

The client automatically enforces conservative rate limits (1 request/second). Includes polite pool support via email configuration for better rate limits. Includes retry logic for transient failures.

Implementations§

Source§

impl CrossRefClient

Source

pub fn new(polite_email: Option<String>) -> Self

Create a new CrossRef API client

§Arguments
  • polite_email - Email for polite pool access (optional but recommended for better rate limits)
§Example
let client = CrossRefClient::new(Some("researcher@university.edu".to_string()));
Source

pub fn with_embedding_dim( polite_email: Option<String>, embedding_dim: usize, ) -> Self

Create a new CrossRef API client with custom embedding dimension

§Arguments
  • polite_email - Email for polite pool access
  • embedding_dim - Dimension for text embeddings (default: 384)
Source

pub async fn search_works( &self, query: &str, limit: usize, ) -> Result<Vec<SemanticVector>>

Search publications by keywords

§Arguments
  • query - Search query (title, abstract, author, etc.)
  • limit - Maximum number of results to return
§Example
let vectors = client.search_works("climate change machine learning", 50).await?;
Source

pub async fn get_work(&self, doi: &str) -> Result<Option<SemanticVector>>

Get a single work by DOI

§Arguments
  • doi - Digital Object Identifier (e.g., “10.1038/nature12373”)
§Example
let work = client.get_work("10.1038/nature12373").await?;
Source

pub async fn search_by_funder( &self, funder_id: &str, limit: usize, ) -> Result<Vec<SemanticVector>>

Search publications funded by a specific organization

§Arguments
  • funder_id - Funder DOI (e.g., “10.13039/100000001” for NSF)
  • limit - Maximum number of results
§Example
// Search NSF-funded research
let nsf_works = client.search_by_funder("10.13039/100000001", 20).await?;
Source

pub async fn search_by_subject( &self, subject: &str, limit: usize, ) -> Result<Vec<SemanticVector>>

Search publications by subject area

§Arguments
  • subject - Subject area or field
  • limit - Maximum number of results
§Example
let biology_works = client.search_by_subject("molecular biology", 30).await?;
Source

pub async fn get_citations( &self, doi: &str, limit: usize, ) -> Result<Vec<SemanticVector>>

Get publications that cite a specific DOI

§Arguments
  • doi - DOI of the work to find citations for
  • limit - Maximum number of results
§Example
let citing_works = client.get_citations("10.1038/nature12373", 15).await?;
Source

pub async fn search_recent( &self, query: &str, from_date: &str, limit: usize, ) -> Result<Vec<SemanticVector>>

Search recent publications since a specific date

§Arguments
  • query - Search query
  • from_date - Start date in YYYY-MM-DD format
  • limit - Maximum number of results
§Example
let recent = client.search_recent("artificial intelligence", "2024-01-01", 25).await?;
Source

pub async fn search_by_type( &self, work_type: &str, query: Option<&str>, limit: usize, ) -> Result<Vec<SemanticVector>>

Search publications by type

§Arguments
  • work_type - Type of publication (e.g., “journal-article”, “book-chapter”, “proceedings-article”, “dataset”)
  • query - Optional search query
  • limit - Maximum number of results
§Supported Types
  • journal-article - Journal articles
  • book-chapter - Book chapters
  • proceedings-article - Conference proceedings
  • dataset - Research datasets
  • monograph - Monographs
  • report - Technical reports
§Example
let datasets = client.search_by_type("dataset", Some("climate"), 10).await?;
let articles = client.search_by_type("journal-article", None, 20).await?;

Trait Implementations§

Source§

impl Default for CrossRefClient

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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, 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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