sift-query-core 0.1.0

Backend-independent query model and strict parameter parser for SiftQuery
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

use crate::{FieldId, FieldRef, RowValue, SearchEntity};

/// A server-declared facet over one entity field.
///
/// The field is validated against the entity metadata before SQL is rendered;
/// this type carries no client-provided SQL identifier or expression.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct FacetRequest {
    field: FieldId,
    schema_fingerprint: u64,
    limit: u32,
    include_null: bool,
    exclude_self_filter: bool,
}

impl FacetRequest {
    #[must_use]
    pub const fn new<E: SearchEntity, T, K>(field: FieldRef<E, T, K>, limit: u32) -> Self {
        Self {
            field: field.id(),
            schema_fingerprint: E::META.schema_fingerprint,
            limit,
            include_null: true,
            exclude_self_filter: false,
        }
    }

    #[must_use]
    pub const fn excluding_nulls(self) -> Self {
        Self {
            include_null: false,
            ..self
        }
    }

    /// Ignores user conditions on this field while computing this facet.
    /// Server-owned scope predicates are always retained.
    #[must_use]
    pub const fn excluding_self_filter(self) -> Self {
        Self {
            exclude_self_filter: true,
            ..self
        }
    }

    #[must_use]
    pub const fn field_id(self) -> FieldId {
        self.field
    }

    #[must_use]
    pub const fn schema_fingerprint(self) -> u64 {
        self.schema_fingerprint
    }

    #[must_use]
    pub const fn limit(self) -> u32 {
        self.limit
    }

    #[must_use]
    pub const fn includes_null(self) -> bool {
        self.include_null
    }

    #[must_use]
    pub const fn excludes_self_filter(self) -> bool {
        self.exclude_self_filter
    }
}

#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
pub struct FacetBucket {
    pub value: RowValue,
    pub count: i64,
}

#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
pub struct FacetResult {
    pub field: &'static str,
    pub buckets: Vec<FacetBucket>,
    pub other_count: i64,
}

impl FacetResult {
    #[must_use]
    pub fn empty(field: &'static str) -> Self {
        Self {
            field,
            buckets: Vec::new(),
            other_count: 0,
        }
    }
}