Struct salvo_core::fs::NamedFile

source ·

pub struct NamedFile { /* private fields */ }

Expand description

A file with an associated name.

This struct represents a file with an associated name. It provides methods for opening and sending the file, as well as setting various headers such as Content-Type and Content-Disposition.

§Examples

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

Implementations§

source §

impl NamedFile

source

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

Create new NamedFileBuilder.

source

pub async fn open(path: P) -> Result<NamedFile>
where P: Into<PathBuf> + Send,

Attempts to open a file in read-only mode.

§Examples

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

source

pub fn file(&self) -> &File

Returns reference to the underlying File object.

source

pub fn path(&self) -> &Path

Retrieve the path of this file.

source

pub fn content_type(&self) -> &Mime

Get content type value.

source

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

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

source

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

Get Content-Disposition value.

source

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

Sets 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.

source

pub fn disable_content_disposition(&mut self)

Disable Content-Disposition header.

By default Content-Disposition` header is enabled.

source

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

Get content encoding value reference.

source

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

Sets content encoding for serving this file

source

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

Get ETag value.

source

pub fn use_etag(&mut self, value: bool)

Specifies whether to use ETag or not.

Default is true.

source

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

GEt last_modified value.

source

pub fn use_last_modified(&mut self, value: bool)

Specifies whether to use Last-Modified or not.

Default is true.

source

pub async fn send(self, req_headers: &HeaderMap, res: &mut Response)

Consume self and send content to Response.

Methods from Deref<Target = File>§

source

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.

source

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.

source

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.

source

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

source

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

source

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

source

pub fn set_max_buf_size(&mut self, max_buf_size: usize)

Set the maximum buffer size for the underlying AsyncRead / AsyncWrite operation.

Although Tokio uses a sensible default value for this buffer size, this function would be useful for changing that default depending on the situation.

§Examples

use tokio::fs::File;
use tokio::io::AsyncWriteExt;

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

// Set maximum buffer size to 8 MiB
file.set_max_buf_size(8 * 1024 * 1024);

let mut buf = vec![1; 1024 * 1024 * 1024];

// Write the 1 GiB buffer in chunks up to 8 MiB each.
file.write_all(&mut buf).await?;