Struct GridFsBucket

pub struct GridFsBucket { /* private fields */ }

Available on crate feature sync only.

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

impl GridFsBucket

pub fn delete(&self, id: Bson) -> Delete<'_>

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.

run will return [Result<()>].

impl GridFsBucket

pub fn open_download_stream(&self, id: Bson) -> OpenDownloadStream<'_>

Opens and returns a GridFsDownloadStream from which the application can read the contents of the stored file specified by id.

run will return Result<GridFsDownloadStream>.

pub fn open_download_stream_by_name( &self, filename: impl Into<String>, ) -> OpenDownloadStreamByName<'_>

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.

run will return Result<GridFsDownloadStream>.

These methods can be chained before run to set options:

• with_options
• revision

impl GridFsBucket

pub fn drop(&self) -> Drop<'_>

Removes all of the files and their associated chunks from this bucket.

run will return [Result<()>].

impl GridFsBucket

pub fn find(&self, filter: Document) -> Find<'_>

Finds and returns the FilesCollectionDocuments within this bucket that match the given filter.

run will return Result<Cursor<FilesCollectionDocument>>.

These methods can be chained before run to set options:

• with_options
• allow_disk_use
• batch_size
• limit
• max_time
• skip
• sort

pub fn find_one(&self, filter: Document) -> FindOne<'_>

Finds and returns a single FilesCollectionDocument within this bucket that matches the given filter.

run will return Result<Option<FilesCollectionDocument>>.

These methods can be chained before run to set options:

• with_options
• max_time
• skip
• sort

impl GridFsBucket

pub fn rename(&self, id: Bson, new_filename: impl Into<String>) -> Rename<'_>

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 will return [Result<()>].

impl GridFsBucket

pub fn open_upload_stream( &self, filename: impl AsRef<str>, ) -> OpenUploadStream<'_>

Creates and returns a GridFsUploadStream that the application can write the contents of the file to.

run will return Result<GridFsUploadStream>.

These methods can be chained before run to set options:

• id
• with_options
• chunk_size_bytes
• metadata

impl GridFsBucket

pub fn read_concern(&self) -> Option<&ReadConcern>

Gets the read concern of the GridFsBucket.

pub fn write_concern(&self) -> Option<&WriteConcern>

Gets the write concern of the GridFsBucket.

pub fn selection_criteria(&self) -> Option<&SelectionCriteria>

Gets the read preference of the GridFsBucket.