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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! Data models for the various metadata fields in other models.
use serde::{Deserialize, Serialize};

/// Annotation metadata.
pub type AnnotationMetadata =
    MetadataWithActions<AnnotationActions, Metadata<AnnotationInteractions>>;
/// User metadata.
pub type UserMetadata = MetadataWithFeatures<Metadata<UserInteractions>>;
/// Metadata with user interactions.
pub type UserInteractionMetadata = Metadata<UserInteractions>;
/// Song metadata.
pub type SongMetadata = MetadataWithActions<
    SongActions,
    MetadataWithRelationships<SongRelationships, Metadata<SongInteractions>>,
>;

/// Metadata.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct Metadata<I> {
    /// Permissions.
    pub permissions: Vec<String>,
    /// Excluded permissions.
    pub excluded_permissions: Vec<String>,
    /// Interactions.
    pub interactions: I,
}

/// Metadata with actions.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct MetadataWithActions<A, M> {
    /// IQ actions.
    pub iq_by_action: A,
    /// Metadata.
    #[serde(flatten)]
    pub metadata: M,
}

/// Metadata with features.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct MetadataWithFeatures<M> {
    /// Features.
    pub features: Vec<String>,
    /// Metadata.
    #[serde(flatten)]
    pub metadata: M,
}

/// Metadata with relationships.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct MetadataWithRelationships<R, M> {
    /// Relationships.
    pub relationships: R,
    /// Metadata.
    #[serde(flatten)]
    pub metadata: M,
}

/// Possible interactions with an annotation.
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize, Default)]
pub struct AnnotationInteractions {
    /// Whether the user cosigned an annotation.
    pub cosign: bool,
    /// Whether the user pyonged an annotation.
    pub pyong: bool,
    /// The vote on an annotation.
    pub vote: Option<Vote>,
}

/// User interactions.
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize, Default)]
pub struct UserInteractions {
    /// If you are following the person.
    pub following: bool,
}

/// Song interactions.
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize, Default)]
pub struct SongInteractions {
    /// Whether the user followers a song.
    pub following: bool,
    /// Whether the user pyonged a song.
    pub pyong: bool,
}

/// Annotation actions.
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize, Default)]
pub struct AnnotationActions {
    /// Accept.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub accept: Option<PrimaryAction>,
    /// Reject.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reject: Option<PrimaryAction>,
    /// Delete.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub delete: Option<PrimaryAction>,
}

/// Song actions.
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize, Default)]
pub struct SongActions {
    /// Editing metadata.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub edit_metadata: Option<PrimaryAction>,
    /// Answering a question.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub answer_question: Option<PrimaryAction>,
}

/// Song relationships.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct SongRelationships {
    /// Pinned role.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pinned_role: Option<String>,
}

/// A primary action.
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize, Default)]
pub struct PrimaryAction {
    /// The action.
    pub primary: Action,
}

/// An action
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize, Default)]
pub struct Action {
    /// Whether the action is applicable.
    pub applicable: bool,
    /// The base value.
    pub base: f32,
    /// The multiplier value.
    pub multiplier: u32,
}

/// A vote.
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Vote {
    /// Upvote.
    Up,
    /// Downvote.
    Down,
}