Struct salvo_core::fs::NamedFile

pub struct NamedFile { /* private fields */ }

A file with an associated name.

Implementations

impl NamedFile

pub fn builder(path: impl Into<PathBuf>) -> NamedFileBuilder

Create new NamedFileBuilder.

pub async fn open(path: impl Into<PathBuf>) -> Result<NamedFile>

Attempts to open a file in read-only mode.

Examples

let file = NamedFile::open("foo.txt").await;

pub async fn send_file(
    path: impl Into<PathBuf>,
    req: &mut Request,
    res: &mut Response
)

Attempts to send a file. If file not exists, not found error will occur.

pub fn file(&self) -> &File

Returns reference to the underlying File object.

pub fn path(&self) -> &Path

Retrieve the path of this file.

pub fn content_type(&self) -> &Mime

Get content type value.

pub fn set_content_type(&mut self, content_type: Mime)

Set the MIME Content-Type for serving this file. By default the Content-Type is inferred from the filename extension.

pub fn content_disposition(&self) -> &HeaderValue

Get Content-Disposition value.

pub fn set_content_disposition(&mut self, content_disposition: HeaderValue)

Set the Content-Disposition for serving this file. This allows changing the inline/attachment disposition as well as the filename sent to the peer.

By default the disposition is inline for text, image, and video content types, and attachment otherwise, and the filename is taken from the path provided in the open method after converting it to UTF-8 using to_string_lossy.

pub fn disable_content_disposition(&mut self)

Disable Content-Disposition header.

By default Content-Disposition` header is enabled.

pub fn content_encoding(&self) -> Option<&HeaderValue>

Get content encoding value reference.

pub fn set_content_encoding(&mut self, content_encoding: HeaderValue)

Set content encoding for serving this file

pub fn etag(&self) -> Option<ETag>

Get ETag value.

pub fn use_etag(self, value: bool)

Specifies whether to use ETag or not.

Default is true.

pub fn last_modified(&self) -> Option<SystemTime>

GEt last_modified value.

pub fn use_last_modified(self, value: bool) -> Self

Specifies whether to use Last-Modified or not.

Default is true.

pub async fn send(self, req: &mut Request, res: &mut Response)

Consume self and send content to Response.

Methods from Deref<Target = File>

pub async fn sync_all(&'_ self) -> Result<(), Error>

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 tokio::fs::File;
use tokio::io::AsyncWriteExt;

let mut file = File::create("foo.txt").await?;
file.write_all(b"hello, world!").await?;
file.sync_all().await?;

The write_all method is defined on the AsyncWriteExt trait.

pub async fn sync_data(&'_ self) -> Result<(), Error>

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 tokio::fs::File;
use tokio::io::AsyncWriteExt;

let mut file = File::create("foo.txt").await?;
file.write_all(b"hello, world!").await?;
file.sync_data().await?;

The write_all method is defined on the AsyncWriteExt trait.

pub async fn set_len(&'_ self, size: u64) -> Result<(), Error>

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 tokio::fs::File;
use tokio::io::AsyncWriteExt;

let mut file = File::create("foo.txt").await?;
file.write_all(b"hello, world!").await?;
file.set_len(10).await?;

The write_all method is defined on the AsyncWriteExt trait.

pub async fn metadata(&'_ self) -> Result<Metadata, Error>

Queries metadata about the underlying file.

Examples

use tokio::fs::File;

let file = File::open("foo.txt").await?;
let metadata = file.metadata().await?;

println!("{:?}", metadata);

pub async fn try_clone(&'_ self) -> Result<File, Error>

Creates a new File instance that shares the same underlying file handle as the existing File instance. Reads, writes, and seeks will affect both File instances simultaneously.

Examples

use tokio::fs::File;

let file = File::open("foo.txt").await?;
let file_clone = file.try_clone().await?;

pub async fn set_permissions(&'_ self, perm: Permissions) -> Result<(), Error>

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 tokio::fs::File;

let file = File::open("foo.txt").await?;
let mut perms = file.metadata().await?.permissions();
perms.set_readonly(true);
file.set_permissions(perms).await?;

Trait Implementations

impl Debug for NamedFile

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

Formats the value using the given formatter.

impl Deref for NamedFile

type Target = File

The resulting type after dereferencing.

fn deref(&self) -> &File

Dereferences the value.

impl DerefMut for NamedFile

fn deref_mut(&mut self) -> &mut File

Mutably dereferences the value.

impl Writer for NamedFile

fn write<'life0, 'life1, 'life2, 'async_trait>(
    self,
    req: &'life0 mut Request,
    _depot: &'life1 mut Depot,
    res: &'life2 mut Response
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Write data to Response.