pub struct OpenAlexClient { /* private fields */ }Expand description
Client for OpenAlex scholarly database
Implementations§
Source§impl OpenAlexClient
impl OpenAlexClient
Sourcepub fn new(user_email: Option<String>) -> Result<Self>
pub fn new(user_email: Option<String>) -> Result<Self>
Create a new OpenAlex client
§Arguments
user_email- Email for polite API usage (optional but recommended)
Sourcepub async fn search_works(
&self,
query: &str,
limit: usize,
) -> Result<Vec<DataRecord>>
pub async fn search_works( &self, query: &str, limit: usize, ) -> Result<Vec<DataRecord>>
Search scholarly works
§Arguments
query- Search query stringlimit- Maximum number of results (max 200 per request)
Sourcepub async fn get_work(&self, id: &str) -> Result<DataRecord>
pub async fn get_work(&self, id: &str) -> Result<DataRecord>
Sourcepub async fn get_citations(&self, work_id: &str) -> Result<Vec<DataRecord>>
pub async fn get_citations(&self, work_id: &str) -> Result<Vec<DataRecord>>
Trait Implementations§
Source§impl DataSource for OpenAlexClient
impl DataSource for OpenAlexClient
Source§fn fetch_batch<'life0, 'async_trait>(
&'life0 self,
cursor: Option<String>,
batch_size: usize,
) -> Pin<Box<dyn Future<Output = Result<(Vec<DataRecord>, Option<String>)>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn fetch_batch<'life0, 'async_trait>(
&'life0 self,
cursor: Option<String>,
batch_size: usize,
) -> Pin<Box<dyn Future<Output = Result<(Vec<DataRecord>, Option<String>)>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Fetch a batch of records starting from cursor
Auto Trait Implementations§
impl Freeze for OpenAlexClient
impl !RefUnwindSafe for OpenAlexClient
impl Send for OpenAlexClient
impl Sync for OpenAlexClient
impl Unpin for OpenAlexClient
impl !UnwindSafe for OpenAlexClient
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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