kodik_api/lib.rs
1//! # `kodik-api-client`
2//!
3//! Асинхронная типизированная библиотека для публичного [Kodik API][kodik].
4//! Транспорт построен на **Hyper + Rustls**, выполнение — на **Tokio**, JSON
5//! разбирается **simd-json**, структуры реализуют **Serde**, а исходящие запросы
6//! ограничиваются **governor**. Ключ API передаётся только при создании клиента;
7//! библиотека не записывает и не логирует его.
8//!
9//! ## Быстрый старт
10//!
11//! ```no_run
12//! use kodik_api::{ContentType, Filters, KodikClient, SearchQuery};
13//!
14//! # #[tokio::main]
15//! # async fn main() -> Result<(), Box<dyn std::error::Error>> {
16//! let client = KodikClient::new(std::env::var("KODIK_API_TOKEN")?)?;
17//! let query = SearchQuery {
18//! title: Some("Avatar".into()),
19//! filters: Filters::default().with_types([ContentType::ForeignMovie]),
20//! ..Default::default()
21//! };
22//! let response = client.search(query).await?;
23//! for material in response.results {
24//! println!("{} — {}", material.id, material.title);
25//! }
26//! # Ok(())
27//! # }
28//! ```
29//!
30//! Метод [`KodikClient::list`] возвращает одну страницу. Сохраните `next_page`,
31//! извлеките из неё курсор [`KodikClient::next_cursor`] и передайте его в
32//! [`ListQuery::next`] следующего запроса. Полное описание входных параметров,
33//! методов и моделей находится в [`docs/API.md`](https://github.com/blassonad/kodik-api/blob/feat/rust-kodik-client/docs/API.md).
34//!
35//! [kodik]: https://kodik-api.com
36
37#![forbid(unsafe_code)]
38
39mod client;
40mod error;
41mod models;
42mod query;
43
44pub use client::{
45 KodikClient, KodikClientBuilder, DEFAULT_BASE_URL, DEFAULT_MAX_RESPONSE_BODY_BYTES,
46 DEFAULT_REQUEST_TIMEOUT,
47};
48pub use error::{Error, Result};
49pub use models::{
50 BlockedSeason, BlockedSeasons, CollectionResponse, Episode, EpisodeData, Episodes, LabelCount,
51 ListResponse, Material, MaterialData, SearchResponse, Season, Seasons, Translation,
52 TranslationCount, YearCount,
53};
54pub use query::{
55 ContentType, CountriesQuery, Filters, GenreSource, GenresQuery, LabelSort, ListQuery, ListSort,
56 QualitiesQuery, RequestMethod, RequiredField, SearchQuery, SortOrder, TranslationType,
57 TranslationsQuery, YearSort, YearsQuery,
58};