Skip to main content

kodik_api/
models.rs

1//! Типы JSON-ответов Kodik API.
2
3use std::collections::BTreeMap;
4
5use serde::{Deserialize, Serialize};
6
7/// Универсальная оболочка ответов справочников: годы, жанры, страны, качества и озвучки.
8#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
9pub struct CollectionResponse<T> {
10    /// Время обработки запроса, сообщаемое API.
11    pub time: String,
12    /// Общее число материалов, удовлетворяющих фильтрам.
13    pub total: u64,
14    /// Строки запрошенного справочника.
15    pub results: Vec<T>,
16}
17
18/// Строка ресурса `/years`.
19#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
20pub struct YearCount {
21    /// Год выпуска материала.
22    pub year: i32,
23    /// Число материалов данного года.
24    pub count: u64,
25}
26
27/// Строка ресурсов `/genres`, `/countries` и `/qualities/v2`.
28#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
29pub struct LabelCount {
30    /// Текстовое значение справочника.
31    pub title: String,
32    /// Число материалов с этим значением.
33    pub count: u64,
34}
35
36/// Строка ресурса `/translations/v2`.
37#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
38pub struct TranslationCount {
39    /// Внутренний ID озвучки Kodik.
40    pub id: u64,
41    /// Название озвучки.
42    pub title: String,
43    /// Число материалов с данной озвучкой.
44    pub count: u64,
45}
46
47/// Страница результатов `/list`.
48#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
49pub struct ListResponse {
50    /// Время обработки запроса, сообщаемое API.
51    pub time: String,
52    /// Общее число материалов, удовлетворяющих фильтрам.
53    pub total: u64,
54    /// URL предыдущей страницы или `null` на первой странице.
55    #[serde(default)]
56    pub prev_page: Option<String>,
57    /// URL следующей страницы или `null` на последней странице.
58    #[serde(default)]
59    pub next_page: Option<String>,
60    /// Материалы текущей страницы.
61    pub results: Vec<Material>,
62}
63
64/// Ответ ресурса `/search`.
65#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
66pub struct SearchResponse {
67    /// Время обработки запроса, сообщаемое API.
68    pub time: String,
69    /// Количество найденных материалов.
70    pub total: u64,
71    /// Материалы, отсортированные API по релевантности и приоритету озвучек.
72    pub results: Vec<Material>,
73}
74
75/// Материал: фильм, сериал, мультфильм, аниме или иной результат Kodik.
76///
77/// Поля, которые Kodik возвращает не для каждого материала или лишь при включённых
78/// параметрах `with_*`, представлены как `Option`.
79#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
80pub struct Material {
81    /// Уникальный идентификатор Kodik, например `movie-452654`.
82    pub id: String,
83    /// Тип материала, например `foreign-movie` или `anime-serial`.
84    #[serde(rename = "type")]
85    pub material_type: String,
86    /// Ссылка на плеер или, при `with_page_links=true`, на страницу плеера.
87    pub link: String,
88    /// Локализованное название.
89    pub title: String,
90    /// Оригинальное название, если есть.
91    #[serde(default)]
92    pub title_orig: Option<String>,
93    /// Дополнительное название, часто используемое для аниме.
94    #[serde(default)]
95    pub other_title: Option<String>,
96    /// Год выпуска.
97    #[serde(default)]
98    pub year: Option<i32>,
99    /// ID КиноПоиска.
100    #[serde(default)]
101    pub kinopoisk_id: Option<String>,
102    /// ID IMDb, обычно вида `tt...`.
103    #[serde(default)]
104    pub imdb_id: Option<String>,
105    /// ID MyDramaList.
106    #[serde(default)]
107    pub mdl_id: Option<String>,
108    /// Полная ссылка на World Art.
109    #[serde(default)]
110    pub worldart_link: Option<String>,
111    /// Числовой ID Shikimori. Представлен строкой, чтобы не терять формат API.
112    #[serde(default)]
113    pub shikimori_id: Option<String>,
114    /// Качество видео.
115    #[serde(default)]
116    pub quality: Option<String>,
117    /// Признак записи с экрана.
118    #[serde(default)]
119    pub camrip: Option<bool>,
120    /// Признак наличия LGBT-сцен.
121    #[serde(default)]
122    pub lgbt: Option<bool>,
123    /// Озвучка либо субтитры, привязанные к этому материалу.
124    pub translation: Translation,
125    /// Дата добавления в ISO 8601, если отдана API.
126    #[serde(default)]
127    pub created_at: Option<String>,
128    /// Дата последнего обновления в ISO 8601, если отдана API.
129    #[serde(default)]
130    pub updated_at: Option<String>,
131    /// Коды стран, в которых просмотр ограничен.
132    #[serde(default)]
133    pub blocked_countries: Vec<String>,
134    /// Сезоны. API добавляет поле при `with_seasons`, `with_episodes` или `with_episodes_data`.
135    #[serde(default)]
136    pub seasons: Option<Seasons>,
137    /// Номер последнего сезона сериала.
138    #[serde(default)]
139    pub last_season: Option<u32>,
140    /// Номер последней серии сериала.
141    #[serde(default)]
142    pub last_episode: Option<u32>,
143    /// Общее число эпизодов сериала.
144    #[serde(default)]
145    pub episodes_count: Option<u32>,
146    /// Ограничения на сезоны и эпизоды сериала.
147    #[serde(default)]
148    pub blocked_seasons: Option<BlockedSeasons>,
149    /// Ссылки на кадры. Для сериалов без детальных эпизодов это кадры первой серии.
150    #[serde(default)]
151    pub screenshots: Vec<String>,
152    /// Внешние метаданные КиноПоиска, Shikimori и MyDramaList при `with_material_data=true`.
153    #[serde(default)]
154    pub material_data: Option<MaterialData>,
155}
156
157/// Привязанная к материалу озвучка или субтитры.
158#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
159pub struct Translation {
160    /// Внутренний ID озвучки Kodik.
161    pub id: u64,
162    /// Отображаемое название озвучки.
163    pub title: String,
164    /// Тип перевода: обычно `voice` или `subtitles`.
165    #[serde(rename = "type")]
166    pub translation_type: String,
167}
168
169/// Коллекция сезонов, ключами которой являются номера сезонов как строки JSON.
170pub type Seasons = BTreeMap<String, Season>;
171
172/// Сезон сериала.
173#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
174pub struct Season {
175    /// Ссылка на плеер сезона.
176    #[serde(default)]
177    pub link: Option<String>,
178    /// Эпизоды, доступные при `with_episodes` или `with_episodes_data`.
179    #[serde(default)]
180    pub episodes: Option<Episodes>,
181}
182
183/// Коллекция серий, ключами которой являются номера эпизодов как строки JSON.
184pub type Episodes = BTreeMap<String, Episode>;
185
186/// Эпизод в кратком или расширенном виде.
187#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
188#[serde(untagged)]
189pub enum Episode {
190    /// Сокращённый вид `with_episodes=true`: непосредственно URL плеера серии.
191    Link(String),
192    /// Расширенный вид `with_episodes_data=true`.
193    Data(EpisodeData),
194}
195
196/// Данные одной серии при `with_episodes_data=true`.
197#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
198pub struct EpisodeData {
199    /// Ссылка на плеер эпизода.
200    pub link: String,
201    /// Название серии, если API располагает им.
202    #[serde(default)]
203    pub title: Option<String>,
204    /// Кадры из этой серии.
205    #[serde(default)]
206    pub screenshots: Vec<String>,
207}
208
209/// Описание блокировок сериалов. Kodik может вернуть строку `"all"` либо карту сезонов.
210#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
211#[serde(untagged)]
212pub enum BlockedSeasons {
213    /// Все сезоны сериала полностью заблокированы.
214    All(String),
215    /// Блокировки отдельных сезонов.
216    BySeason(BTreeMap<String, BlockedSeason>),
217}
218
219/// Блокировка одного сезона.
220#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
221#[serde(untagged)]
222pub enum BlockedSeason {
223    /// Все эпизоды сезона заблокированы; ожидаемое значение — `"all"`.
224    All(String),
225    /// Заблокированы только эпизоды с указанными номерами.
226    Episodes(Vec<String>),
227}
228
229/// Дополнительные сведения о материале из КиноПоиска, Shikimori и MyDramaList.
230///
231/// Каждый член необязателен: Kodik не возвращает данные, которых нет в источниках.
232#[derive(Clone, Debug, Default, Deserialize, Serialize, PartialEq)]
233pub struct MaterialData {
234    pub title: Option<String>,
235    pub anime_title: Option<String>,
236    pub title_en: Option<String>,
237    pub other_titles: Option<Vec<String>>,
238    pub other_titles_en: Option<Vec<String>>,
239    pub other_titles_jp: Option<Vec<String>>,
240    pub anime_license_name: Option<String>,
241    pub anime_licensed_by: Option<Vec<String>>,
242    pub anime_kind: Option<String>,
243    pub mydramalist_tags: Option<Vec<String>>,
244    pub all_status: Option<String>,
245    pub anime_status: Option<String>,
246    pub drama_status: Option<String>,
247    pub year: Option<i32>,
248    pub tagline: Option<String>,
249    pub description: Option<String>,
250    pub anime_description: Option<String>,
251    pub poster_url: Option<String>,
252    pub anime_poster_url: Option<String>,
253    pub drama_poster_url: Option<String>,
254    pub screenshots: Option<Vec<String>>,
255    pub duration: Option<u32>,
256    pub countries: Option<Vec<String>>,
257    pub all_genres: Option<Vec<String>>,
258    pub genres: Option<Vec<String>>,
259    pub anime_genres: Option<Vec<String>>,
260    pub drama_genres: Option<Vec<String>>,
261    pub anime_studios: Option<Vec<String>>,
262    pub kinopoisk_rating: Option<f64>,
263    pub kinopoisk_votes: Option<u64>,
264    pub imdb_rating: Option<f64>,
265    pub imdb_votes: Option<u64>,
266    pub shikimori_rating: Option<f64>,
267    pub shikimori_votes: Option<u64>,
268    pub mydramalist_rating: Option<f64>,
269    pub mydramalist_votes: Option<u64>,
270    pub premiere_ru: Option<String>,
271    pub premiere_world: Option<String>,
272    pub aired_at: Option<String>,
273    pub released_at: Option<String>,
274    pub next_episode_at: Option<String>,
275    pub rating_mpaa: Option<String>,
276    pub minimal_age: Option<u32>,
277    pub episodes_total: Option<u32>,
278    pub episodes_aired: Option<u32>,
279    pub actors: Option<Vec<String>>,
280    pub directors: Option<Vec<String>>,
281    pub producers: Option<Vec<String>>,
282    pub writers: Option<Vec<String>>,
283    pub composers: Option<Vec<String>>,
284    pub editors: Option<Vec<String>>,
285    pub designers: Option<Vec<String>>,
286    pub operators: Option<Vec<String>>,
287}