Struct iroh_io::File

pub struct File(_);

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

Implementations

impl File

pub async fn create( create_file: impl Fn() -> 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

type ReadAtFuture<'a> = ReadAtFuture<'a>

The future returned by read_at

fn read_at(&mut self, offset: u64, len: usize) -> Self::ReadAtFuture<'_>

Read the entire buffer at the given position.

type LenFuture<'a> = LenFuture<'a>

The future returned by len

fn len(&mut self) -> Self::LenFuture<'_>

Get the length of the resource

impl AsyncSliceWriter for File

type WriteBytesAtFuture<'a> = WriteBytesAtFuture<'a>

The future returned by write_bytes_at

fn write_bytes_at( &mut self, offset: u64, data: Bytes ) -> Self::WriteBytesAtFuture<'_>

Write the entire Bytes at the given position.

type WriteAtFuture<'a> = WriteAtFuture<'a>

The future returned by write_at

fn write_at(&mut self, offset: u64, data: &[u8]) -> Self::WriteAtFuture<'_>

Write the entire slice at the given position.

type SyncFuture<'a> = SyncFuture<'a>

The future returned by sync

fn sync(&mut self) -> Self::SyncFuture<'_>

Sync any buffers to the underlying storage.

type SetLenFuture<'a> = SetLenFuture<'a>

The future returned by set_len

fn set_len(&mut self, len: u64) -> Self::SetLenFuture<'_>

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.