1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
//! Wrapper for [Openlibrary's Web API](https://openlibrary.org/developers/api)
//!
//! There are currently 8 sub APIs offered by Openlibrary's Web API.
//! This library is still in development and does not have a wrapper for each yet.
//! You can check the table below to see the status of each.
//!
//! - [ ] Books
//! - [ ] Authors
//! - [ ] Subjects
//! - [X] Search
//! - [ ] Search inside
//! - [ ] Partner
//! - [ ] Covers
//! - [ ] Recent Changes
//!
//! # Search
//!
//! You can search for books, authors, and more using the [`search::Search`] struct[^note]
//!
//! Example
//! ``` rust
//! use openlibrary_rs::search::SearchBuilder;
//!
//! fn main() {
//! // execute search and pretty print debug of first result
//! let results = SearchBuilder::default()
//! .query("the lord of the rings")
//! .build()
//! .unwrap();
//!
//! println!("{:#?}", results.execute().docs[0]);
//! }
//! ```
//!
//! [^note]: You must use the [`search::SearchBuilder`] to build instances of [`search::Search`] as all fields are private
pub mod search;