Crate async_fs

Async filesystem primitives.

This crate is an async version of std::fs.

Implementation

This crate uses blocking to offload blocking I/O onto a thread pool.

Examples

Create a new file and write some bytes to it:

use async_fs::File;
use futures_lite::io::AsyncWriteExt;

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

Re-exports

pub use std::fs::FileType;

pub use std::fs::Metadata;

pub use std::fs::Permissions;

Modules

windows

Windows-specific extensions.

Structs

DirBuilder

A builder for creating directories with configurable options.

DirEntry

An entry in a directory.

File

An open file on the filesystem.

OpenOptions

A builder for opening files with configurable options.

ReadDir

A stream of entries in a directory.

Functions

canonicalize

Returns the canonical form of a path.

copy

Copies a file to a new location.

create_dir

Creates a directory.

create_dir_all

Creates a directory and its parent directories if they are missing.

hard_link

Creates a hard link on the filesystem.

metadata

Reads metadata for a path.

read

Reads the entire contents of a file as raw bytes.

read_dir

Returns a stream of entries in a directory.

read_link

Reads a symbolic link and returns the path it points to.

read_to_string

Reads the entire contents of a file as a string.

remove_dir

Removes an empty directory.

remove_dir_all

Removes a directory and all of its contents.

remove_file

Removes a file.

rename

Renames a file or directory to a new location.

set_permissions

Changes the permissions of a file or directory.

symlink_metadata

Reads metadata for a path without following symbolic links.

write

Writes a slice of bytes as the new contents of a file.