Struct rocket::response::NamedFile
[−]
[src]
pub struct NamedFile(_, _);
A file with an associated name; responds with the Content-Type based on the file extension.
Methods
impl NamedFile
[src]
fn open<P: AsRef<Path>>(path: P) -> Result<NamedFile>
Attempts to open a file in read-only mode.
Errors
This function will return an error if path does not already exist. Other errors may also be returned according to OpenOptions::open.
Examples
use rocket::response::NamedFile; let file = NamedFile::open("foo.txt");
fn file(&self) -> &File
Retrieve the underlying File
.
fn take_file(self) -> File
Take the underlying File
.
fn file_mut(&mut self) -> &mut File
Retrieve a mutable borrow to the underlying File
.
fn path(&self) -> &Path
Retrieve the path of this file.
Examples
use rocket::response::NamedFile; let file = NamedFile::open("foo.txt")?; assert_eq!(file.path().as_os_str(), "foo.txt");
Methods from Deref<Target=File>
fn sync_all(&self) -> Result<(), Error>
1.0.0
Attempts to sync all OS-internal metadata to disk.
This function will attempt to ensure that all in-core data reaches the filesystem before returning.
Examples
use std::fs::File; use std::io::prelude::*; let mut f = File::create("foo.txt")?; f.write_all(b"Hello, world!")?; f.sync_all()?;
fn sync_data(&self) -> Result<(), Error>
1.0.0
This function is similar to sync_all
, except that it may not
synchronize file metadata to the filesystem.
This is intended for use cases that must synchronize content, but don't need the metadata on disk. The goal of this method is to reduce disk operations.
Note that some platforms may simply implement this in terms of
sync_all
.
Examples
use std::fs::File; use std::io::prelude::*; let mut f = File::create("foo.txt")?; f.write_all(b"Hello, world!")?; f.sync_data()?;
fn set_len(&self, size: u64) -> Result<(), Error>
1.0.0
Truncates or extends the underlying file, updating the size of
this file to become size
.
If the size
is less than the current file's size, then the file will
be shrunk. If it is greater than the current file's size, then the file
will be extended to size
and have all of the intermediate data filled
in with 0s.
Errors
This function will return an error if the file is not opened for writing.
Examples
use std::fs::File; let mut f = File::create("foo.txt")?; f.set_len(10)?;
fn metadata(&self) -> Result<Metadata, Error>
1.0.0
Queries metadata about the underlying file.
Examples
use std::fs::File; let mut f = File::open("foo.txt")?; let metadata = f.metadata()?;
fn try_clone(&self) -> Result<File, Error>
1.9.0
Creates a new independently owned handle to the underlying file.
The returned File
is a reference to the same state that this object
references. Both handles will read and write with the same cursor
position.
Examples
use std::fs::File; let mut f = File::open("foo.txt")?; let file_copy = f.try_clone()?;
fn set_permissions(&self, perm: Permissions) -> Result<(), Error>
1.16.0
Changes the permissions on the underlying file.
Platform-specific behavior
This function currently corresponds to the fchmod
function on Unix and
the SetFileInformationByHandle
function on Windows. Note that, this
may change in the future.
Errors
This function will return an error if the user lacks permission change attributes on the underlying file. It may also return an error in other os-specific unspecified cases.
Examples
use std::fs::File; let file = File::open("foo.txt")?; let mut perms = file.metadata()?.permissions(); perms.set_readonly(true); file.set_permissions(perms)?;
Trait Implementations
impl Debug for NamedFile
[src]
impl<'r> Responder<'r> for NamedFile
[src]
Streams the named file to the client. Sets or overrides the Content-Type in
the response according to the file's extension if the extension is
recognized. See
ContentType::from_extension
for more information. If you would like to stream a file with a different
Content-Type than that implied by its extension, use a File
directly.
fn respond(self) -> Result<Response<'r>, Status>
Returns Ok
if a Response
could be generated successfully. Otherwise, returns an Err
with a failing Status
. Read more
impl Deref for NamedFile
[src]
type Target = File
The resulting type after dereferencing
fn deref(&self) -> &File
The method called to dereference a value
impl DerefMut for NamedFile
[src]
impl Read for NamedFile
[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
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>
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
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
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0
Transforms this Read
instance to an Iterator
over its bytes. Read more
fn chars(self) -> Chars<Self>
🔬 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
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0
Creates an adaptor which will read at most limit
bytes from it. Read more
impl Write for NamedFile
[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<()>
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
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Write
. Read more
impl Seek for NamedFile
[src]
fn seek(&mut self, pos: SeekFrom) -> Result<u64>
Seek to an offset, in bytes, in a stream. Read more
impl<'a> Read for &'a NamedFile
[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
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>
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
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
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0
Transforms this Read
instance to an Iterator
over its bytes. Read more
fn chars(self) -> Chars<Self>
🔬 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
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0
Creates an adaptor which will read at most limit
bytes from it. Read more
impl<'a> Write for &'a NamedFile
[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<()>
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
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Write
. Read more