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]
impl FileⓘImportant traits for Filepub fn new(gfs: Store, id: ObjectId, mode: Mode) -> File[src]
pub fn new(gfs: Store, id: ObjectId, mode: Mode) -> FileA new file stream with an id-referenced GridFS file.
ⓘImportant traits for Filepub fn with_name(gfs: Store, name: String, id: ObjectId, mode: Mode) -> File[src]
pub fn with_name(gfs: Store, name: String, id: ObjectId, mode: Mode) -> FileA new file stream with a name-and-id-referenced GridFS file.
ⓘImportant traits for Filepub fn with_doc(gfs: Store, doc: Document) -> File[src]
pub fn with_doc(gfs: Store, doc: Document) -> FileA new file stream from a read file document.
pub fn len(&self) -> i64[src]
pub fn len(&self) -> i64Returns the byte length of the file.
pub fn is_empty(&self) -> bool[src]
pub fn is_empty(&self) -> boolReturns true if the file contains no bytes.
pub fn err_description(&self) -> Result<Option<String>>[src]
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<()>[src]
pub fn assert_mode(&self, mode: Mode) -> Result<()>Ensures the file mode matches the desired mode.
pub fn close(&mut self) -> Result<()>[src]
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>>[src]
pub fn find_chunk(&mut self, id: ObjectId, chunk_num: i32) -> Result<Vec<u8>>Methods from Deref<Target = GfsFile>
Trait Implementations
impl Deref for File[src]
impl Deref for Filetype Target = GfsFile
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target[src]
fn deref(&self) -> &Self::TargetDereferences the value.
impl DerefMut for File[src]
impl DerefMut for Fileimpl Write for File[src]
impl Write for Filefn write(&mut self, buf: &[u8]) -> Result<usize>[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>[src]
fn flush(&mut self) -> Result<()>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]
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>1.0.0[src]
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self1.0.0[src]
fn by_ref(&mut self) -> &mut SelfCreates a "by reference" adaptor for this instance of Write. Read more
impl Read for File[src]
impl Read for Filefn read(&mut self, buf: &mut [u8]) -> Result<usize>[src]
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. Read more
unsafe fn initializer(&self) -> Initializer[src]
unsafe fn initializer(&self) -> Initializerread_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]
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. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>Read all bytes until EOF in this source, appending them to buf. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>1.6.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>Read the exact number of bytes required to fill buf. Read more
fn by_ref(&mut self) -> &mut Self1.0.0[src]
fn by_ref(&mut self) -> &mut SelfCreates a "by reference" adaptor for this instance of Read. Read more
fn bytes(self) -> Bytes<Self>1.0.0[src]
fn bytes(self) -> Bytes<Self>Transforms this Read instance to an [Iterator] over its bytes. Read more
fn chars(self) -> Chars<Self>[src]
fn chars(self) -> Chars<Self>: Use str::from_utf8 instead: https://doc.rust-lang.org/nightly/std/str/struct.Utf8Error.html#examples
🔬 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]
fn chain<R>(self, next: R) -> Chain<Self, R> where
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]
fn take(self, limit: u64) -> Take<Self>Creates an adaptor which will read at most limit bytes from it. Read more
impl Drop for File[src]
impl Drop for File