Struct File

pub struct File(/* private fields */);

A wrapper around a std::fs::File that implements AsyncSliceReader and AsyncSliceWriter

Implementations

impl File

pub async fn create( create_file: impl FnOnce() -> Result<File> + Send + 'static, ) -> Result<Self>

Create a new File from a function that creates a std::fs::File

pub fn from_std(file: File) -> Self

Create a new File from a std::fs::File

This is fine if you already have a std::fs::File and want to use it with File, but opening a file is a blocking op that you probably don’t want to do in an async context.

pub async fn open(path: PathBuf) -> Result<Self>

Open a File from a path

Trait Implementations

impl AsyncSliceReader for File

async fn read_at(&mut self, offset: u64, len: usize) -> Result<Bytes>

Read the entire buffer at the given position.

async fn size(&mut self) -> Result<u64>

Get the length of the resource

fn read_exact_at( &mut self, offset: u64, len: usize, ) -> impl Future<Output = Result<Bytes>>

Variant of read_at that returns an error if less than len bytes are read.

impl AsyncSliceWriter for File

async fn write_bytes_at(&mut self, offset: u64, data: Bytes) -> Result<()>

Write the entire Bytes at the given position.

async fn write_at(&mut self, offset: u64, data: &[u8]) -> Result<()>

Write the entire slice at the given position.

async fn sync(&mut self) -> Result<()>

Sync any buffers to the underlying storage.

async fn set_len(&mut self, len: u64) -> Result<()>

Set the length of the underlying storage.

impl Debug for File

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

Formats the value using the given formatter.