Struct mongodb::gridfs::file::File

pub struct File {
    pub doc: GfsFile,
    // some fields omitted
}

A writable or readable file stream within GridFS.

Fields

doc: GfsFile

The file document associated with this stream.

Methods

impl File

Important traits for File

impl Write for Fileimpl Read for File

pub fn new(gfs: Store, id: ObjectId, mode: Mode) -> File

A new file stream with an id-referenced GridFS file.

Important traits for File

impl Write for Fileimpl Read for File

pub fn with_name(gfs: Store, name: String, id: ObjectId, mode: Mode) -> File

A new file stream with a name-and-id-referenced GridFS file.

Important traits for File

impl Write for Fileimpl Read for File

pub fn with_doc(gfs: Store, doc: Document) -> File

A new file stream from a read file document.

pub fn len(&self) -> i64

Returns the byte length of the file.

pub fn is_empty(&self) -> bool

Returns true if the file contains no bytes.

pub fn err_description(&self) -> Result<Option<String>>

Retrieves the description of the threaded error, if one occurred.

pub fn assert_mode(&self, mode: Mode) -> Result<()>

Ensures the file mode matches the desired mode.

pub fn close(&mut self) -> Result<()>

Completes writing or reading and closes the file. This will be called when the file is dropped, but errors will be ignored. Therefore, this method should be called manually.

pub fn find_chunk(&mut self, id: ObjectId, chunk_num: i32) -> Result<Vec<u8>>

Methods from Deref<Target = GfsFile>

pub fn to_bson(&self) -> Document

Converts a GfsFile into a bson document.

Trait Implementations

impl Drop for File

fn drop(&mut self)

Executes the destructor for this type.

impl DerefMut for File

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Deref for File

type Target = GfsFile

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Debug for File

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

Formats the value using the given formatter.

impl Write for File

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.

impl Read for File

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.