mongodb 3.3.0

The official MongoDB driver for Rust
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
130
131
132
133
134
135
136
137
138
139
140

use std::marker::PhantomData;

use crate::bson::{Bson, Document};

#[cfg(feature = "sync")]
use crate::sync::Client as SyncClient;
use crate::{
    db::options::ListDatabasesOptions,
    error::{ErrorKind, Result},
    operation::list_databases as op,
    results::DatabaseSpecification,
    Client,
    ClientSession,
};

use super::{
    action_impl,
    deeplink,
    export_doc,
    option_setters,
    options_doc,
    ListNames,
    ListSpecifications,
};

impl Client {
    /// Gets information about each database present in the cluster the Client is connected to.
    ///
    /// `await` will return d[`Result<Vec<DatabaseSpecification>>`].
    #[deeplink]
    #[options_doc(list_databases)]
    pub fn list_databases(&self) -> ListDatabases {
        ListDatabases {
            client: self,
            options: Default::default(),
            session: None,
            mode: PhantomData,
        }
    }

    /// Gets the names of the databases present in the cluster the Client is connected to.
    ///
    /// `await` will return d[`Result<Vec<String>>`].
    #[deeplink]
    #[options_doc(list_databases)]
    pub fn list_database_names(&self) -> ListDatabases<'_, ListNames> {
        ListDatabases {
            client: self,
            options: Default::default(),
            session: None,
            mode: PhantomData,
        }
    }
}

#[cfg(feature = "sync")]
impl SyncClient {
    /// Gets information about each database present in the cluster the Client is connected to.
    ///
    /// [run](ListDatabases::run) will return d[`Result<Vec<DatabaseSpecification>>`].
    #[deeplink]
    #[options_doc(list_databases, sync)]
    pub fn list_databases(&self) -> ListDatabases {
        self.async_client.list_databases()
    }

    /// Gets the names of the databases present in the cluster the Client is connected to.
    ///
    /// [run](ListDatabases::run) will return d[`Result<Vec<String>>`].
    #[deeplink]
    #[options_doc(list_databases, sync)]
    pub fn list_database_names(&self) -> ListDatabases<'_, ListNames> {
        self.async_client.list_database_names()
    }
}

/// Gets information about each database present in the cluster the Client is connected to.  Create
/// by calling [`Client::list_databases`] or [`Client::list_database_names`].
#[must_use]
pub struct ListDatabases<'a, M = ListSpecifications> {
    client: &'a Client,
    options: Option<ListDatabasesOptions>,
    session: Option<&'a mut ClientSession>,
    mode: PhantomData<M>,
}

#[option_setters(crate::db::options::ListDatabasesOptions)]
#[export_doc(list_databases)]
impl<'a, M> ListDatabases<'a, M> {
    /// Use the provided session when running the operation.
    pub fn session(mut self, value: impl Into<&'a mut ClientSession>) -> Self {
        self.session = Some(value.into());
        self
    }
}

#[action_impl]
impl<'a> Action for ListDatabases<'a, ListSpecifications> {
    type Future = ListDatabasesFuture;

    async fn execute(self) -> Result<Vec<DatabaseSpecification>> {
        let op = op::ListDatabases::new(false, self.options);
        self.client
            .execute_operation(op, self.session)
            .await
            .and_then(|dbs| {
                dbs.into_iter()
                    .map(|db_spec| {
                        crate::bson_compat::deserialize_from_slice(db_spec.as_bytes())
                            .map_err(crate::error::Error::from)
                    })
                    .collect()
            })
    }
}

#[action_impl]
impl<'a> Action for ListDatabases<'a, ListNames> {
    type Future = ListDatabaseNamesFuture;

    async fn execute(self) -> Result<Vec<String>> {
        let op = op::ListDatabases::new(true, self.options);
        match self.client.execute_operation(op, self.session).await {
            Ok(databases) => databases
                .into_iter()
                .map(|doc| {
                    let name = doc
                        .get_str("name")
                        .map_err(|_| ErrorKind::InvalidResponse {
                            message: "Expected \"name\" field in server response, but it was not \
                                      found"
                                .to_string(),
                        })?;
                    Ok(name.to_string())
                })
                .collect(),
            Err(e) => Err(e),
        }
    }
}