Skip to main content

Crate kodik_api

Crate kodik_api 

Source
Expand description

§kodik-api-client

Асинхронная типизированная библиотека для публичного Kodik API. Транспорт построен на Hyper + Rustls, выполнение — на Tokio, JSON разбирается simd-json, структуры реализуют Serde, а исходящие запросы ограничиваются governor. Ключ API передаётся только при создании клиента; библиотека не записывает и не логирует его.

§Быстрый старт

use kodik_api::{ContentType, Filters, KodikClient, SearchQuery};

let client = KodikClient::new(std::env::var("KODIK_API_TOKEN")?)?;
let query = SearchQuery {
    title: Some("Avatar".into()),
    filters: Filters::default().with_types([ContentType::ForeignMovie]),
    ..Default::default()
};
let response = client.search(query).await?;
for material in response.results {
    println!("{} — {}", material.id, material.title);
}

Метод KodikClient::list возвращает одну страницу. Сохраните next_page, извлеките из неё курсор KodikClient::next_cursor и передайте его в ListQuery::next следующего запроса. Полное описание входных параметров, методов и моделей находится в docs/API.md.

Structs§

CollectionResponse
Универсальная оболочка ответов справочников: годы, жанры, страны, качества и озвучки.
CountriesQuery
Запрос к /countries.
EpisodeData
Данные одной серии при with_episodes_data=true.
Filters
Общие фильтры материалов, доступные в /years, /genres, /countries, /qualities/v2, /translations/v2, /list и /search.
GenresQuery
Запрос к /genres.
KodikClient
Многопоточно-безопасный клиент Kodik API.
KodikClientBuilder
Построитель KodikClient.
LabelCount
Строка ресурсов /genres, /countries и /qualities/v2.
ListQuery
Запрос к /list.
ListResponse
Страница результатов /list.
Material
Материал: фильм, сериал, мультфильм, аниме или иной результат Kodik.
MaterialData
Дополнительные сведения о материале из КиноПоиска, Shikimori и MyDramaList.
QualitiesQuery
Запрос к /qualities/v2.
SearchQuery
Параметры точного и нечёткого поиска /search.
SearchResponse
Ответ ресурса /search.
Season
Сезон сериала.
Translation
Привязанная к материалу озвучка или субтитры.
TranslationCount
Строка ресурса /translations/v2.
TranslationsQuery
Запрос к /translations/v2.
YearCount
Строка ресурса /years.
YearsQuery
Запрос к /years.

Enums§

BlockedSeason
Блокировка одного сезона.
BlockedSeasons
Описание блокировок сериалов. Kodik может вернуть строку "all" либо карту сезонов.
ContentType
Тип материала, который Kodik принимает в параметре types.
Episode
Эпизод в кратком или расширенном виде.
Error
Ошибка, возникшая при подготовке или выполнении запроса к Kodik API.
GenreSource
Типы списка жанров, который должен вернуть /genres.
LabelSort
Сортировка строкового справочника: стран, жанров, качеств и озвучек.
ListSort
Поле сортировки /list.
RequestMethod
HTTP-способ передачи параметров к Kodik API.
RequiredField
Поле внешнего идентификатора, требуемое параметрами has_field и has_field_and.
SortOrder
Направление сортировки /list.
TranslationType
Тип перевода в Kodik.
YearSort
Сортировка списка лет.

Constants§

DEFAULT_BASE_URL
Адрес публичного Kodik API по умолчанию.
DEFAULT_MAX_RESPONSE_BODY_BYTES
Максимальное число байтов, которые клиент прочитает из одного ответа.
DEFAULT_REQUEST_TIMEOUT
Максимальная продолжительность одного HTTP-обмена после прохождения rate limiter.

Type Aliases§

Episodes
Коллекция серий, ключами которой являются номера эпизодов как строки JSON.
Result
Результат операции библиотеки Kodik API.
Seasons
Коллекция сезонов, ключами которой являются номера сезонов как строки JSON.