Struct salvo::fs::NamedFile [−][src]
pub struct NamedFile {
pub buffer_size: u64,
// some fields omitted
}Expand description
A file with an associated name.
Fields
buffer_size: u64Implementations
Attempts to open a file in read-only mode.
Examples
use salvo_core::fs::NamedFile;
let file = NamedFile::open("foo.txt".into()).await;Retrieve the path of this file.
Examples
let file = NamedFile::open("test.txt".into()).await.unwrap();
assert_eq!(file.path().as_os_str(), "foo.txt");Set the MIME Content-Type for serving this file. By default the Content-Type is inferred from the filename extension.
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.
Disable Content-Disposition header.
By default Content-Disposition` header is enabled.
Set content encoding for serving this file
Specifies whether to use ETag or not.
Default is true.
Specifies whether to use Last-Modified or not.
Default is true.
Methods from Deref<Target = File>
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.
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.
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.
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);Create 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>
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?;