Struct mongodb::sync::gridfs::GridFsBucket
source · pub struct GridFsBucket { /* private fields */ }
sync
or tokio-sync
only.Expand description
A GridFsBucket
provides the functionality for storing and retrieving binary BSON data that
exceeds the 16 MiB size limit of a MongoDB document. Users may upload and download large amounts
of data, called files, to the bucket. When a file is uploaded, its contents are divided into
chunks and stored in a chunks collection. A corresponding FilesCollectionDocument
is also
stored in a files collection. When a user downloads a file, the bucket finds and returns the
data stored in its chunks.
GridFsBucket
uses std::sync::Arc
internally, so it can be shared safely across threads or
async tasks.
Implementations§
source§impl GridFsBucket
impl GridFsBucket
sourcepub fn read_concern(&self) -> Option<&ReadConcern>
pub fn read_concern(&self) -> Option<&ReadConcern>
Gets the read concern of the GridFsBucket
.
sourcepub fn write_concern(&self) -> Option<&WriteConcern>
pub fn write_concern(&self) -> Option<&WriteConcern>
Gets the write concern of the GridFsBucket
.
sourcepub fn selection_criteria(&self) -> Option<&SelectionCriteria>
pub fn selection_criteria(&self) -> Option<&SelectionCriteria>
Gets the read preference of the GridFsBucket
.
sourcepub fn delete(&self, id: Bson) -> Result<()>
pub fn delete(&self, id: Bson) -> Result<()>
Deletes the FilesCollectionDocument
with the given id
and its associated chunks from
this bucket. This method returns an error if the id
does not match any files in the
bucket.
sourcepub fn find(
&self,
filter: Document,
options: impl Into<Option<GridFsFindOptions>>
) -> Result<Cursor<FilesCollectionDocument>>
pub fn find( &self, filter: Document, options: impl Into<Option<GridFsFindOptions>> ) -> Result<Cursor<FilesCollectionDocument>>
Finds the FilesCollectionDocument
s in the bucket matching the given filter
.
source§impl GridFsBucket
impl GridFsBucket
sourcepub fn open_download_stream(&self, id: Bson) -> Result<GridFsDownloadStream>
pub fn open_download_stream(&self, id: Bson) -> Result<GridFsDownloadStream>
Opens and returns a GridFsDownloadStream
from which the application can read
the contents of the stored file specified by id
.
sourcepub fn open_download_stream_by_name(
&self,
filename: impl AsRef<str>,
options: impl Into<Option<GridFsDownloadByNameOptions>>
) -> Result<GridFsDownloadStream>
pub fn open_download_stream_by_name( &self, filename: impl AsRef<str>, options: impl Into<Option<GridFsDownloadByNameOptions>> ) -> Result<GridFsDownloadStream>
Opens and returns a GridFsDownloadStream
from which the application can read
the contents of the stored file specified by filename
.
If there are multiple files in the bucket with the given filename, the revision
in the
options provided is used to determine which one to download. See the documentation for
GridFsDownloadByNameOptions
for details on how to specify a revision. If no revision is
provided, the file with filename
most recently uploaded will be downloaded.
source§impl GridFsBucket
impl GridFsBucket
sourcepub fn open_upload_stream(
&self,
filename: impl AsRef<str>,
options: impl Into<Option<GridFsUploadOptions>>
) -> GridFsUploadStream ⓘ
pub fn open_upload_stream( &self, filename: impl AsRef<str>, options: impl Into<Option<GridFsUploadOptions>> ) -> GridFsUploadStream ⓘ
Creates and returns a GridFsUploadStream
that the application can write the contents of
the file to. This method generates a unique ObjectId
for the
corresponding FilesCollectionDocument
’s id
field that can be accessed via the
stream’s id
method.
sourcepub fn open_upload_stream_with_id(
&self,
id: Bson,
filename: impl AsRef<str>,
options: impl Into<Option<GridFsUploadOptions>>
) -> GridFsUploadStream ⓘ
pub fn open_upload_stream_with_id( &self, id: Bson, filename: impl AsRef<str>, options: impl Into<Option<GridFsUploadOptions>> ) -> GridFsUploadStream ⓘ
Opens a GridFsUploadStream
that the application can write the contents of the file to.
The provided id
will be used for the corresponding FilesCollectionDocument
’s id
field.
Auto Trait Implementations§
impl Freeze for GridFsBucket
impl !RefUnwindSafe for GridFsBucket
impl Send for GridFsBucket
impl Sync for GridFsBucket
impl Unpin for GridFsBucket
impl !UnwindSafe for GridFsBucket
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.