auditlog 0.1.0

Audit trail for your data models — an ORM-agnostic core with a pluggable, async sqlx backend (SQLite & Postgres).
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

//! A fluent builder for auditlog's audit scopes.

use chrono::{DateTime, Utc};

use crate::action::Action;
use crate::audit::Audit;
use crate::backend::{AuditQuery, Backend, Order};
use crate::error::Result;
use crate::id::AuditId;

/// Builds and runs an audit query for a single auditable record (or its associated audits).
///
/// Obtain one via [`crate::Auditable::query`] / [`crate::Auditable::associated_query`], chain
/// scope methods, then `.fetch()`:
///
/// ```no_run
/// # async fn demo(backend: &dyn auditlog::Backend) -> auditlog::Result<()> {
/// # use auditlog::Auditable;
/// # struct Post; #[auditlog::async_trait] impl Auditable for Post {
/// #   fn auditable_type() -> &'static str { "Post" }
/// #   fn auditable_id(&self) -> auditlog::AuditId { 1.into() }
/// #   fn audited_attributes(&self) -> auditlog::ValueMap { Default::default() }
/// #   fn audit_options() -> auditlog::AuditOptions { auditlog::AuditOptions::default() }
/// # }
/// let updates = Post::query(backend, 1).updates().descending().limit(5).fetch().await?;
/// # Ok(()) }
/// ```
pub struct AuditQueryBuilder<'a> {
    backend: &'a dyn Backend,
    type_name: String,
    id: AuditId,
    associated: bool,
    query: AuditQuery,
}

impl<'a> AuditQueryBuilder<'a> {
    pub(crate) fn new(
        backend: &'a dyn Backend,
        type_name: String,
        id: AuditId,
        associated: bool,
    ) -> Self {
        AuditQueryBuilder {
            backend,
            type_name,
            id,
            associated,
            query: AuditQuery::default(),
        }
    }

    /// Only `create` audits.
    pub fn creates(mut self) -> Self {
        self.query.action = Some(Action::Create);
        self
    }

    /// Only `update` audits.
    pub fn updates(mut self) -> Self {
        self.query.action = Some(Action::Update);
        self
    }

    /// Only `destroy` audits.
    pub fn destroys(mut self) -> Self {
        self.query.action = Some(Action::Destroy);
        self
    }

    /// `version >= from_version`.
    pub fn from_version(mut self, version: i32) -> Self {
        self.query.from_version = Some(version);
        self
    }

    /// `version <= to_version`.
    pub fn to_version(mut self, version: i32) -> Self {
        self.query.to_version = Some(version);
        self
    }

    /// `created_at <= time`.
    pub fn up_until(mut self, time: DateTime<Utc>) -> Self {
        self.query.up_until = Some(time);
        self
    }

    /// Order by `version` ascending (the default).
    pub fn ascending(mut self) -> Self {
        self.query.order = Order::VersionAsc;
        self
    }

    /// Order by `version` descending.
    pub fn descending(mut self) -> Self {
        self.query.order = Order::VersionDesc;
        self
    }

    /// Limit the number of rows.
    pub fn limit(mut self, limit: i64) -> Self {
        self.query.limit = Some(limit);
        self
    }

    /// Offset the rows.
    pub fn offset(mut self, offset: i64) -> Self {
        self.query.offset = Some(offset);
        self
    }

    /// Run the query.
    pub async fn fetch(self) -> Result<Vec<Audit>> {
        if self.associated {
            self.backend
                .audits_for_associated(&self.type_name, &self.id, &self.query)
                .await
        } else {
            self.backend
                .audits_for_auditable(&self.type_name, &self.id, &self.query)
                .await
        }
    }

    /// Run the query and return the number of matching rows.
    pub async fn count(self) -> Result<usize> {
        Ok(self.fetch().await?.len())
    }
}