Struct mongodb::gridfs::file::File
[−]
[src]
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[src]
fn new(gfs: Store, id: ObjectId, mode: Mode) -> File[src]
A new file stream with an id-referenced GridFS file.
fn with_name(gfs: Store, name: String, id: ObjectId, mode: Mode) -> File[src]
A new file stream with a name-and-id-referenced GridFS file.
fn with_doc(gfs: Store, doc: Document) -> File[src]
A new file stream from a read file document.
fn len(&self) -> i64[src]
Returns the byte length of the file.
fn is_empty(&self) -> bool[src]
Returns true if the file contains no bytes.
fn err_description(&self) -> Result<Option<String>>[src]
Retrieves the description of the threaded error, if one occurred.
fn assert_mode(&self, mode: Mode) -> Result<()>[src]
Ensures the file mode matches the desired mode.
fn close(&mut self) -> Result<()>[src]
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.
fn find_chunk(&mut self, id: ObjectId, chunk_num: i32) -> Result<Vec<u8>>[src]
Methods from Deref<Target = GfsFile>
Trait Implementations
impl Deref for File[src]
type Target = GfsFile
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target[src]
Dereferences the value.
impl DerefMut for File[src]
impl Write for File[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>[src]
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>[src]
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>1.0.0[src]
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>1.0.0[src]
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self1.0.0[src]
Creates a "by reference" adaptor for this instance of Write. Read more
impl Read for File[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>[src]
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
unsafe fn initializer(&self) -> Initializer[src]
read_initializer)Determines if this Reader can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>1.0.0[src]
Read all bytes until EOF in this source, placing them into buf. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>1.0.0[src]
Read all bytes until EOF in this source, placing them into buf. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>1.6.0[src]
Read the exact number of bytes required to fill buf. Read more
fn by_ref(&mut self) -> &mut Self1.0.0[src]
Creates a "by reference" adaptor for this instance of Read. Read more
fn bytes(self) -> Bytes<Self>1.0.0[src]
Transforms this Read instance to an [Iterator] over its bytes. Read more
fn chars(self) -> Chars<Self>[src]
🔬 This is a nightly-only experimental API. (io)
the semantics of a partial read/write of where errors happen is currently unclear and may change
Transforms this Read instance to an [Iterator] over [char]s. Read more
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read, 1.0.0[src]
R: Read,
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>1.0.0[src]
Creates an adaptor which will read at most limit bytes from it. Read more