kellnr-docs 6.3.0

Kellnr is a self-hosted registry for Rust crates with support for rustdocs and crates.io caching.
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

use kellnr_db::DocQueueEntry;
use serde::{Deserialize, Serialize};
use utoipa::ToSchema;

/// Response containing documentation build queue
#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, ToSchema)]
pub struct DocQueueResponse {
    /// List of crates in the documentation build queue
    pub(crate) queue: Vec<DocQueueEntryResponse>,
}

/// Entry in the documentation build queue
#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, ToSchema)]
pub struct DocQueueEntryResponse {
    /// Crate name
    pub(crate) name: String,
    /// Crate version
    pub(crate) version: String,
}

impl From<Vec<DocQueueEntry>> for DocQueueResponse {
    fn from(entries: Vec<DocQueueEntry>) -> Self {
        Self {
            queue: entries
                .into_iter()
                .map(|e| DocQueueEntryResponse {
                    name: e.normalized_name.to_string(),
                    version: e.version,
                })
                .collect(),
        }
    }
}

#[cfg(test)]
mod tests {
    use std::path::PathBuf;

    use kellnr_common::normalized_name::NormalizedName;

    use super::*;

    #[test]
    fn doc_queue_response_from_doc_queue_entry() {
        let doc_queue = vec![
            DocQueueEntry {
                id: 0,
                normalized_name: NormalizedName::from_unchecked("crate1".to_string()),
                version: "0.0.1".to_string(),
                path: PathBuf::default(),
            },
            DocQueueEntry {
                id: 1,
                normalized_name: NormalizedName::from_unchecked("crate2".to_string()),
                version: "0.0.2".to_string(),
                path: PathBuf::default(),
            },
        ];

        let doc_queue_response = DocQueueResponse::from(doc_queue);

        assert_eq!(
            DocQueueResponse {
                queue: vec![
                    DocQueueEntryResponse {
                        name: "crate1".to_string(),
                        version: "0.0.1".to_string()
                    },
                    DocQueueEntryResponse {
                        name: "crate2".to_string(),
                        version: "0.0.2".to_string()
                    }
                ]
            },
            doc_queue_response
        );
    }
}