[go: up one dir, main page]

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

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

use crate::{
    action::action_impl,
    error::{ErrorKind, GridFsErrorKind, GridFsFileIdentifier, Result},
    gridfs::GridFsBucket,
};

impl GridFsBucket {
    /// Renames the file with the given 'id' to the provided `new_filename`. This method returns an
    /// error if the `id` does not match any files in the bucket.
    ///
    /// `await` will return [`Result<()>`].
    pub fn rename(&self, id: Bson, new_filename: impl Into<String>) -> Rename {
        Rename {
            bucket: self,
            id,
            new_filename: new_filename.into(),
        }
    }

    /// Renames all revisions of the file with the given name to the provided `new_filename`. This
    /// method returns an error if the name does not match any files in the bucket.
    ///
    /// `await` will return [`Result<()>`].
    pub fn rename_by_name(
        &self,
        filename: impl Into<String>,
        new_filename: impl Into<String>,
    ) -> RenameByName {
        RenameByName {
            bucket: self,
            filename: filename.into(),
            new_filename: new_filename.into(),
        }
    }
}

#[cfg(feature = "sync")]
impl crate::sync::gridfs::GridFsBucket {
    /// Renames the file with the given `id` to the provided `new_filename`. This method returns an
    /// error if the `id` does not match any files in the bucket.
    ///
    /// [`run`](Rename::run) will return [`Result<()>`].
    pub fn rename(&self, id: Bson, new_filename: impl Into<String>) -> Rename {
        self.async_bucket.rename(id, new_filename)
    }

    /// Renames all revisions of the file with the given name to the provided `new_filename`. This
    /// method returns an error if the name does not match any files in the bucket.
    ///
    /// [`run`](RenameByName::run) will return [`Result<()>`].
    pub fn rename_by_name(
        &self,
        filename: impl Into<String>,
        new_filename: impl Into<String>,
    ) -> RenameByName {
        self.async_bucket.rename_by_name(filename, new_filename)
    }
}

/// Renames a file.  Construct with [`GridFsBucket::rename`].
#[must_use]
pub struct Rename<'a> {
    bucket: &'a GridFsBucket,
    id: Bson,
    new_filename: String,
}

#[action_impl]
impl<'a> Action for Rename<'a> {
    type Future = RenameFuture;

    async fn execute(self) -> Result<()> {
        let count = self
            .bucket
            .files()
            .update_one(
                doc! { "_id": self.id.clone() },
                doc! { "$set": { "filename": self.new_filename } },
            )
            .await?
            .matched_count;
        if count == 0 {
            return Err(ErrorKind::GridFs(GridFsErrorKind::FileNotFound {
                identifier: GridFsFileIdentifier::Id(self.id),
            })
            .into());
        }

        Ok(())
    }
}

/// Renames a file selected by name.  Construct with [`GridFsBucket::rename_by_name`].
#[must_use]
pub struct RenameByName<'a> {
    bucket: &'a GridFsBucket,
    filename: String,
    new_filename: String,
}

#[action_impl]
impl<'a> Action for RenameByName<'a> {
    type Future = RenameByNameFuture;

    async fn execute(self) -> Result<()> {
        let count = self
            .bucket
            .files()
            .update_many(
                doc! { "filename": self.filename.clone() },
                doc! { "$set": { "filename": self.new_filename } },
            )
            .await?
            .matched_count;
        if count == 0 {
            return Err(ErrorKind::GridFs(GridFsErrorKind::FileNotFound {
                identifier: GridFsFileIdentifier::Filename(self.filename),
            })
            .into());
        }

        Ok(())
    }
}