scitadel-core 0.1.0

Core domain models, services, and ports for the scitadel scientific-literature retrieval toolkit.
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

mod assessment;
mod citation;
mod doi;
mod paper;
mod question;
mod search;

pub use assessment::Assessment;
pub use citation::{Citation, CitationDirection, SnowballRun};
pub use doi::{doi_to_filename, normalize_doi, validate_doi};
pub use paper::{CandidatePaper, Paper};
pub use question::{ResearchQuestion, SearchTerm};
pub use search::{Search, SearchResult, SourceOutcome, SourceStatus};

use serde::{Deserialize, Serialize};
use uuid::Uuid;

/// Newtype wrapper for type-safe IDs.
macro_rules! newtype_id {
    ($name:ident) => {
        #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
        #[serde(transparent)]
        pub struct $name(pub String);

        impl $name {
            #[must_use]
            pub fn new() -> Self {
                Self(Uuid::new_v4().simple().to_string())
            }

            #[must_use]
            pub fn as_str(&self) -> &str {
                &self.0
            }

            #[must_use]
            pub fn short(&self) -> &str {
                &self.0[..self.0.len().min(8)]
            }

            #[must_use]
            pub fn starts_with(&self, prefix: &str) -> bool {
                self.0.starts_with(prefix)
            }
        }

        impl Default for $name {
            fn default() -> Self {
                Self::new()
            }
        }

        impl std::fmt::Display for $name {
            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                write!(f, "{}", self.0)
            }
        }

        impl From<String> for $name {
            fn from(s: String) -> Self {
                Self(s)
            }
        }

        impl From<&str> for $name {
            fn from(s: &str) -> Self {
                Self(s.to_string())
            }
        }

        impl AsRef<str> for $name {
            fn as_ref(&self) -> &str {
                &self.0
            }
        }
    };
}

newtype_id!(PaperId);
newtype_id!(SearchId);
newtype_id!(QuestionId);
newtype_id!(AssessmentId);
newtype_id!(SearchTermId);
newtype_id!(SnowballRunId);