Trait AsyncMmapFileExt

Source

pub trait AsyncMmapFileExt: Sync {
Show 50 methods    // Required methods
    fn len(&self) -> usize;
    fn as_slice(&self) -> &[u8] ⓘ;
    fn path(&self) -> &Path;
    fn is_exec(&self) -> bool;
    fn metadata(&self) -> impl Future<Output = Result<MetaData>> + Send;
    fn lock_exclusive(&self) -> Result<()>;
    fn lock_shared(&self) -> Result<()>;
    fn try_lock_exclusive(&self) -> Result<()>;
    fn try_lock_shared(&self) -> Result<()>;
    fn unlock(&self) -> Result<()>;

    // Provided methods
    fn is_empty(&self) -> bool { ... }
    fn slice(&self, offset: usize, sz: usize) -> &[u8] ⓘ { ... }
    fn bytes(&self, offset: usize, sz: usize) -> Result<&[u8]> { ... }
    fn path_buf(&self) -> PathBuf { ... }
    fn path_lossy(&self) -> Cow<'_, str> { ... }
    fn path_string(&self) -> String { ... }
    fn copy_all_to_vec(&self) -> Vec<u8> ⓘ { ... }
    fn copy_range_to_vec(&self, offset: usize, len: usize) -> Vec<u8> ⓘ { ... }
    fn write_all_to_new_file<P: AsRef<Path> + Send + Sync>(
        &self,
        new_file_path: P,
    ) -> impl Future<Output = Result<()>> + Send { ... }
    fn write_range_to_new_file<P: AsRef<Path> + Send + Sync>(
        &self,
        new_file_path: P,
        offset: usize,
        len: usize,
    ) -> impl Future<Output = Result<()>> + Send { ... }
    fn reader(&self, offset: usize) -> Result<AsyncMmapFileReader<'_>> { ... }
    fn range_reader(
        &self,
        offset: usize,
        len: usize,
    ) -> Result<AsyncMmapFileReader<'_>> { ... }
    fn read(&self, dst: &mut [u8], offset: usize) -> usize { ... }
    fn read_exact(&self, dst: &mut [u8], offset: usize) -> Result<()> { ... }
    fn read_i8(&self, offset: usize) -> Result<i8> { ... }
    fn read_i16(&self, offset: usize) -> Result<i16> { ... }
    fn read_i16_le(&self, offset: usize) -> Result<i16> { ... }
    fn read_isize(&self, offset: usize) -> Result<isize> { ... }
    fn read_isize_le(&self, offset: usize) -> Result<isize> { ... }
    fn read_i32(&self, offset: usize) -> Result<i32> { ... }
    fn read_i32_le(&self, offset: usize) -> Result<i32> { ... }
    fn read_i64(&self, offset: usize) -> Result<i64> { ... }
    fn read_i64_le(&self, offset: usize) -> Result<i64> { ... }
    fn read_i128(&self, offset: usize) -> Result<i128> { ... }
    fn read_i128_le(&self, offset: usize) -> Result<i128> { ... }
    fn read_u8(&self, offset: usize) -> Result<u8> { ... }
    fn read_u16(&self, offset: usize) -> Result<u16> { ... }
    fn read_u16_le(&self, offset: usize) -> Result<u16> { ... }
    fn read_usize(&self, offset: usize) -> Result<usize> { ... }
    fn read_usize_le(&self, offset: usize) -> Result<usize> { ... }
    fn read_u32(&self, offset: usize) -> Result<u32> { ... }
    fn read_u32_le(&self, offset: usize) -> Result<u32> { ... }
    fn read_u64(&self, offset: usize) -> Result<u64> { ... }
    fn read_u64_le(&self, offset: usize) -> Result<u64> { ... }
    fn read_u128(&self, offset: usize) -> Result<u128> { ... }
    fn read_u128_le(&self, offset: usize) -> Result<u128> { ... }
    fn read_f32(&self, offset: usize) -> Result<f32> { ... }
    fn read_f32_le(&self, offset: usize) -> Result<f32> { ... }
    fn read_f64(&self, offset: usize) -> Result<f64> { ... }
    fn read_f64_le(&self, offset: usize) -> Result<f64> { ... }
}

Available on crate feature async-std only.

Expand description

Utility methods to AsyncMmapFile

Required Methods§

Source

fn len(&self) -> usize

Returns the current mmap length

Source

fn as_slice(&self) -> &[u8] ⓘ

Returns the underlying slice of the mmap

Source

fn path(&self) -> &Path

Returns the path of the inner file.

Source

fn is_exec(&self) -> bool

Whether the mmap is executable

Source

fn metadata(&self) -> impl Future<Output = Result<MetaData>> + Send

Returns the metadata of file metadata

Metadata information about a file. This structure is returned from the metadata or symlink_metadata function or method and represents known metadata about a file such as its permissions, size, modification times, etc

Source