openauth-core 0.0.4

Core types and primitives for OpenAuth.
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

use indexmap::IndexMap;
use serde::{Deserialize, Serialize};

/// User-facing join request before schema relation metadata has been resolved.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct JoinOption {
    pub enabled: bool,
    pub limit: Option<usize>,
}

impl JoinOption {
    pub fn enabled() -> Self {
        Self {
            enabled: true,
            limit: None,
        }
    }

    pub fn disabled() -> Self {
        Self {
            enabled: false,
            limit: None,
        }
    }

    pub fn limit(mut self, limit: usize) -> Self {
        self.limit = Some(limit);
        self
    }
}

/// Resolved join column pair.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct JoinOn {
    pub from: String,
    pub to: String,
}

impl JoinOn {
    pub fn new(from: impl Into<String>, to: impl Into<String>) -> Self {
        Self {
            from: from.into(),
            to: to.into(),
        }
    }
}

/// Resolved relation kind for joined output.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum JoinRelation {
    OneToOne,
    OneToMany,
    ManyToMany,
}

/// Adapter-facing join configuration after relation metadata is resolved.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct JoinConfig {
    pub on: JoinOn,
    pub limit: Option<usize>,
    pub relation: JoinRelation,
}

impl JoinConfig {
    pub fn new(from: impl Into<String>, to: impl Into<String>) -> Self {
        Self {
            on: JoinOn::new(from, to),
            limit: None,
            relation: JoinRelation::OneToMany,
        }
    }

    pub fn limit(mut self, limit: usize) -> Self {
        self.limit = Some(limit);
        self
    }

    pub fn relation(mut self, relation: JoinRelation) -> Self {
        self.relation = relation;
        self
    }
}

/// Resolved join metadata plus any base select fields required to execute it.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct JoinResolution {
    pub joins: IndexMap<String, JoinConfig>,
    pub select: Vec<String>,
}

impl JoinResolution {
    pub fn new(select: Vec<String>) -> Self {
        Self {
            joins: IndexMap::new(),
            select,
        }
    }
}