megamind 0.13.0

A library for interacting with the Genius API.
Documentation 
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

//! Data models for search results.
//!
//! Visit the [Genius documentation](https://docs.genius.com/#search-h2) for more context.
#[cfg(feature = "catchall")]
use std::collections::HashMap;

use serde::{Deserialize, Serialize};

#[cfg(feature = "catchall")]
use serde_json::Value;

use super::{SongCoreStats, SongCoreWithRDC};

/// A search response.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct SearchResponse {
    /// Search hits.
    pub hits: Vec<Hit>,
}

/// A search hit.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(tag = "type")]
#[serde(rename_all = "lowercase")]
pub enum Hit {
    /// Song hit.
    Song(HitCore<SongCoreWithRDC<SongCoreStats>>),
}

/// Core search hit data.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct HitCore<R> {
    /// Details about search term matches in the hit. Seems to be empty for all hits.
    pub highlights: Vec<()>,
    /// Index of the hit.
    pub index: HitIndex,
    /// Resulting data.
    pub result: R,
    /// Extra data.
    #[cfg(feature = "catchall")]
    #[serde(flatten)]
    pub extra: HashMap<String, Value>,
}

/// Search hit index.
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize, Default)]
#[serde(rename_all = "lowercase")]

pub enum HitIndex {
    /// A song.
    #[default]
    Song,
}