relay-knowledge 1.1.16

Graph-database-based knowledge graph project.
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

use serde::{Deserialize, Serialize};

use crate::domain::GraphVersion;

use super::RequestContext;

/// Common metadata that every successful API response must carry.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ApiMetadata {
    pub trace_id: String,
    pub request_id: String,
    pub graph_version: u64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub index_version: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub indexed_graph_version: Option<u64>,
    pub stale: bool,
}

impl ApiMetadata {
    /// Builds response metadata for graph-only operations.
    pub fn graph_only(context: &RequestContext, graph_version: GraphVersion) -> Self {
        Self {
            trace_id: context.trace_id.clone(),
            request_id: context.request_id.clone(),
            graph_version: graph_version.get(),
            index_version: None,
            indexed_graph_version: None,
            stale: false,
        }
    }

    /// Builds response metadata for operations that used derived indexes.
    pub fn indexed(
        context: &RequestContext,
        graph_version: GraphVersion,
        index_version: Option<u64>,
        indexed_graph_version: Option<GraphVersion>,
        stale: bool,
    ) -> Self {
        Self {
            trace_id: context.trace_id.clone(),
            request_id: context.request_id.clone(),
            graph_version: graph_version.get(),
            index_version,
            indexed_graph_version: indexed_graph_version.map(GraphVersion::get),
            stale,
        }
    }
}