Структура File

Пытается открыть файл в режиме только для чтения.

Подробнее см. OpenOptions.

Ошибки

Эта функция вернёт ошибку, если её вызвать вне среды выполнения Tokio или если файл по указанному пути не существует. Также могут быть возвращены другие ошибки в соответствии с OpenOptions::open.

Примеры

use tokio::fs::File;
use tokio::io::AsyncReadExt;

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

let mut contents = vec![];
file.read_to_end(&mut contents).await?;

println!("len = {}", contents.len());

Метод read_to_end определён в трейте AsyncReadExt.

Открывает файл в режиме только для записи.

Эта функция создаст файл, если он не существует, и очистит его содержимое, если он существует.

Подробнее см. OpenOptions.

Ошибки

Возвращает ошибку, если вызвана вне среды выполнения Tokio или если вызов create для нижележащего объекта завершается ошибкой.

Примеры

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

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

Метод write_all определён в трейте AsyncWriteExt.

Открывает файл в режиме чтения и записи.

Эта функция создаст файл, если он не существует, или вернёт ошибку, если он существует. Таким образом, при успешном выполнении гарантируется, что возвращённый файл является новым.

Этот параметр удобен тем, что операция атомарна. В противном случае между проверкой существования файла и созданием нового файла его может создать другой процесс (состояние гонки TOCTOU / атака).

Это также можно записать с помощью File::options().read(true).write(true).create_new(true).open(...).

Подробнее см. OpenOptions.

Примеры

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

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

Метод write_all определён в трейте AsyncWriteExt.

Возвращает новый объект OpenOptions.

Эта функция возвращает новый объект OpenOptions, который можно использовать для открытия или создания файла с заданными параметрами, если open() или create() не подходят.

Это эквивалентно OpenOptions::new(), но позволяет писать более понятный код. Вместо OpenOptions::new().append(true).open("example.log") можно написать File::options().append(true).open("example.log"). Кроме того, это избавляет от необходимости импортировать OpenOptions.

Подробнее см. функцию OpenOptions::new.

Примеры

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

let mut f = File::options().append(true).open("example.log").await?;
f.write_all(b"new line\n").await?;

Преобразует std::fs::File в tokio::fs::File.

Примеры

// This line could block. It is not recommended to do this on the Tokio
// runtime.
let std_file = std::fs::File::open("foo.txt").unwrap();
let file = tokio::fs::File::from_std(std_file);

Пытается синхронизировать все внутренние метаданные ОС с диском.

Эта функция пытается обеспечить запись всех данных, находящихся в памяти, в файловую систему до возврата.

Примеры

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

Метод write_all определён в трейте AsyncWriteExt.

Эта функция похожа на sync_all, за исключением того, что она может не синхронизировать метаданные файла с файловой системой.

Она предназначена для случаев, когда необходимо синхронизировать содержимое, но метаданные на диске не нужны. Цель этого метода — сократить количество операций с диском.

Обратите внимание, что на некоторых платформах этот метод может быть реализован просто через sync_all.

Примеры

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

Метод write_all определён в трейте AsyncWriteExt.

Усекает или расширяет базовый файл, изменяя его размер на size.

Если size меньше текущего размера файла, файл будет уменьшен. Если он больше текущего размера файла, файл будет расширен до size, а все промежуточные данные будут заполнены нулями.

Ошибки

Эта функция вернёт ошибку, если файл не открыт для записи.

Примеры

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

Метод write_all определён в трейте AsyncWriteExt.

Получает метаданные базового файла.

Примеры

use tokio::fs::File;

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

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

Создаёт новый экземпляр File, использующий тот же базовый файловый дескриптор, что и существующий экземпляр File. Чтение, запись и перемещение по файлу будут одновременно влиять на оба экземпляра File.

Примеры

use tokio::fs::File;

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

Преобразует File в std::fs::File. Эта функция является асинхронной, чтобы все выполняющиеся операции могли завершиться.

Чтобы выполнить преобразование немедленно, используйте File::try_into_std.

Примеры

use tokio::fs::File;

let tokio_file = File::open("foo.txt").await?;
let std_file = tokio_file.into_std().await;

Пытается немедленно преобразовать File в std::fs::File.

Ошибки

Эта функция вернёт ошибку, содержащую файл, если какая-либо операция ещё выполняется.

Примеры

use tokio::fs::File;

let tokio_file = File::open("foo.txt").await?;
let std_file = tokio_file.try_into_std().unwrap();

Изменяет права доступа к базовому файлу.

Поведение зависит от платформы

В настоящее время эта функция соответствует функции fchmod в Unix и функции SetFileInformationByHandle в Windows. Обратите внимание, что это может измениться в будущем.

Ошибки

Эта функция вернёт ошибку, если у пользователя недостаточно прав для изменения атрибутов базового файла. Она также может возвращать ошибку в других неуказанных случаях, специфичных для ОС.

Примеры

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

Задаёт максимальный размер буфера для операции с базовым AsyncRead / AsyncWrite.

Хотя Tokio использует разумное значение по умолчанию для размера этого буфера, эта функция полезна, когда необходимо изменить значение по умолчанию в зависимости от ситуации.

Примеры

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

Возвращает максимальный размер буфера для операции с базовым AsyncRead / AsyncWrite.

Возвращает аргумент без изменений.

Вызывает U::from(self).

То есть это преобразование выполняется так, как того требует реализация From<T> for U.