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]

[src]

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");

Important traits for &'a File
[src]

Retrieve the underlying File.

Important traits for &'a File
[src]

Take the underlying File.

Important traits for &'a File
[src]

Retrieve a mutable borrow to the underlying File.

[src]

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>

1.0.0
[src]

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()?;

1.0.0
[src]

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()?;

1.0.0
[src]

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)?;

1.0.0
[src]

Queries metadata about the underlying file.

Examples

use std::fs::File;

let mut f = File::open("foo.txt")?;
let metadata = f.metadata()?;

1.9.0
[src]

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()?;

1.16.0
[src]

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]

[src]

Formats the value using the given formatter. Read more

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.

[src]

Returns Ok if a Response could be generated successfully. Otherwise, returns an Err with a failing Status. Read more

impl Deref for NamedFile
[src]

The resulting type after dereferencing.

Important traits for &'a File
[src]

Dereferences the value.

impl DerefMut for NamedFile
[src]

Important traits for &'a File
[src]

Mutably dereferences the value.

impl Read for NamedFile
[src]

[src]

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

[src]

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

[src]

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

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

1.0.0
[src]

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

1.6.0
[src]

Read the exact number of bytes required to fill buf. Read more

Important traits for &'a mut W
1.0.0
[src]

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

Important traits for Bytes<R>
1.0.0
[src]

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

Important traits for Chars<R>
[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

Important traits for Chain<T, U>
1.0.0
[src]

Creates an adaptor which will chain this stream with another. Read more

Important traits for Take<T>
1.0.0
[src]

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

impl Write for NamedFile
[src]

[src]

Write a buffer into this object, returning how many bytes were written. Read more

[src]

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

1.0.0
[src]

Attempts to write an entire buffer into this write. Read more

1.0.0
[src]

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

Important traits for &'a mut W
1.0.0
[src]

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

impl Seek for NamedFile
[src]

[src]

Seek to an offset, in bytes, in a stream. Read more

impl<'a> Read for &'a NamedFile
[src]

[src]

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

[src]

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

[src]

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

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

1.0.0
[src]

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

1.6.0
[src]

Read the exact number of bytes required to fill buf. Read more

Important traits for &'a mut W
1.0.0
[src]

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

Important traits for Bytes<R>
1.0.0
[src]

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

Important traits for Chars<R>
[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

Important traits for Chain<T, U>
1.0.0
[src]

Creates an adaptor which will chain this stream with another. Read more

Important traits for Take<T>
1.0.0
[src]

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

impl<'a> Write for &'a NamedFile
[src]

[src]

Write a buffer into this object, returning how many bytes were written. Read more

[src]

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

1.0.0
[src]

Attempts to write an entire buffer into this write. Read more

1.0.0
[src]

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

Important traits for &'a mut W
1.0.0
[src]

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

impl<'a> Seek for &'a NamedFile
[src]

[src]

Seek to an offset, in bytes, in a stream. Read more