kbolt-types 0.1.2

Shared request and response types for kbolt
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

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub enum Locator {
    Path(String),
    DocId(String),
}

impl Locator {
    pub fn parse(raw: &str) -> Self {
        let trimmed = raw.trim();
        if trimmed.contains('/') {
            return Self::Path(trimmed.to_string());
        }

        Self::DocId(trimmed.trim_start_matches('#').to_string())
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct GetRequest {
    pub locator: Locator,
    pub space: Option<String>,
    pub offset: Option<usize>,
    pub limit: Option<usize>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct DocumentResponse {
    pub docid: String,
    pub path: String,
    pub title: String,
    pub space: String,
    pub collection: String,
    pub content: String,
    pub stale: bool,
    pub total_lines: usize,
    pub returned_lines: usize,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct MultiGetRequest {
    pub locators: Vec<Locator>,
    pub space: Option<String>,
    pub max_files: usize,
    pub max_bytes: usize,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct MultiGetResponse {
    pub documents: Vec<DocumentResponse>,
    pub omitted: Vec<OmittedFile>,
    pub resolved_count: usize,
    pub warnings: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct OmittedFile {
    pub path: String,
    pub docid: String,
    pub size_bytes: usize,
    pub reason: OmitReason,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub enum OmitReason {
    MaxFiles,
    MaxBytes,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct FileEntry {
    pub path: String,
    pub title: String,
    pub docid: String,
    pub active: bool,
    pub chunk_count: usize,
    pub embedded: bool,
}

#[cfg(test)]
mod tests {
    use super::Locator;

    #[test]
    fn parse_preserves_relative_paths() {
        assert_eq!(
            Locator::parse(" api/src/lib.rs "),
            Locator::Path("api/src/lib.rs".to_string())
        );
    }

    #[test]
    fn parse_normalizes_docids() {
        assert_eq!(
            Locator::parse(" #abc123 "),
            Locator::DocId("abc123".to_string())
        );
    }
}