btfm-api-structs 0.3.1

Structures used in BTFM's HTTP 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

use chrono::NaiveDateTime;
use serde::{Deserialize, Serialize};

use crate::Phrases;

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Clip {
    /// The unique identifier for the clip and primary key for the table.
    pub ulid: ulid::Ulid,
    /// The time when the clip was added to the database.
    pub created_on: NaiveDateTime,
    /// The last time the clip was played; this is equal to `created_on` when created.
    pub last_played: NaiveDateTime,
    /// Number of times the clip has been played.
    pub plays: i64,
    /// The output of speech-to-text on the `audio_file`, optionally used as a matching phrase.
    pub speech_detected: String,
    /// A description of the clip for human consumption.
    pub description: String,
    /// Path to the audio file, relative to the BTFM_DATA_DIR.
    pub audio_file: String,
    /// Phrases associated with the clip.
    pub phrases: Option<Phrases>,
}

#[derive(Debug, Deserialize, Serialize)]
pub struct Clips {
    pub items: u64,
    pub clips: Vec<Clip>,
}

#[derive(Debug, Deserialize, Serialize)]
pub struct ClipUpload {
    pub description: String,
    pub phrases: Option<Vec<String>>,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ClipUpdated {
    /// The new clip.
    pub new_clip: Clip,
    /// The old clip.
    pub old_clip: Clip,
}