aragog 0.17.1

A simple lightweight object-document mapper for ArangoDB
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

use crate::Error;
use arangors_lite::Collection;
use std::ops::Deref;

/// Struct containing the connection information on a `ArangoDB` collection
#[derive(Debug, Clone)]
pub struct DatabaseCollection {
    /// The collection wrapper accessor of `arangors_lite` crate driver
    collection: Collection,
}

impl DatabaseCollection {
    /// Name of the collection, exactly as defined in database
    #[must_use]
    #[inline]
    pub fn name(&self) -> &str {
        self.collection.name()
    }

    /// Retrieves the total document count of this collection.
    ///
    /// # Returns
    ///
    /// On success a `i32` is returned as the document count.
    /// On failure a Error wil be returned.
    #[maybe_async::maybe_async]
    pub async fn record_count(&self) -> Result<u32, Error> {
        let properties = match self.collection.document_count().await {
            Ok(value) => value,
            Err(client_error) => return Err(Error::from(client_error)),
        };
        properties.info.count.map_or(Ok(0), Ok)
    }
}

impl From<Collection> for DatabaseCollection {
    fn from(collection: Collection) -> Self {
        Self { collection }
    }
}

impl Deref for DatabaseCollection {
    type Target = Collection;

    fn deref(&self) -> &Self::Target {
        &self.collection
    }
}