Struct GridFile 

pub struct GridFile {
    pub id: Uuid,
    pub filename: String,
    pub details: Option<FileDetails>,
    pub metadata: Option<Document>,
    /* private fields */
}

A representation of a file in GridFS

Fields

id: Uuid

The file’s ID

filename: String

The filename of this file

details: Option<FileDetails>

Resolved details about the file, if it’s been uploaded already.

metadata: Option<Document>

Arbitrary metadata stored in the file’s document

Implementations

impl GridFile

pub async fn read(&self) -> MResult<GridReader>

Creates a GridReader to read this file.

Panics: If the GridFS instance has not been attached.

pub async fn write(self) -> MResult<GridWriter>

Creates a GridWriter to write this file into GridFS. This method takes ownership of the GridFile, which will be returned by GridWriter::commit()

Panics: If the GridFS instance has not been attached.

pub fn metadata<T: DeserializeOwned>(&self) -> Option<T>

Gets the file’s metadata (if present) and attempts to convert it to the specified type. Returns None if no metadata exists or if deserialization fails.

pub fn untyped_metadata(&self) -> Option<Document>

Returns the raw bson::Document of the metadata, if present.

Trait Implementations

impl Clone for GridFile

fn clone(&self) -> GridFile

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GridFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GridFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GridFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.