Struct Annotated

pub struct Annotated<Tag: Debug + Default + Display + Send + Sync, S: Storage> {
    inner: S,
    tag: Tag,
}

Annotating wrapper around storage objects.

Wraps other storage objects, adding an arbitrary tag to them.

Fields

inner: S

Wrapped storage object.

tag: Tag

Tag.

Implementations

impl<T: Debug + Default + Display + Send + Sync, S: Storage> Annotated<T, S>

pub fn new(storage: S, tag: T) -> Self

Wrap storage, adding the tag tag.

pub fn tag(&self) -> &T

Get the tag.

pub fn tag_mut(&mut self) -> &mut T

Allow modifying or changing the tag.

Trait Implementations

impl<Tag: Debug + Debug + Default + Display + Send + Sync, S: Debug + Storage> Debug for Annotated<Tag, S>

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

Formats the value using the given formatter.

impl<T: Debug + Default + Display + Send + Sync, S: Storage> Deref for Annotated<T, S>

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &S

Dereferences the value.

impl<T: Debug + Default + Display + Send + Sync, S: Storage> DerefMut for Annotated<T, S>

fn deref_mut(&mut self) -> &mut S

Mutably dereferences the value.

impl<T: Debug + Default + Display + Send + Sync, S: Storage> Display for Annotated<T, S>

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

Formats the value using the given formatter.

impl<T: Debug + Default + Display + Send + Sync, S: Storage> From<S> for Annotated<T, S>

fn from(storage: S) -> Self

Converts to this type from the input type.

impl<T: Debug + Default + Display + Send + Sync, S: Storage> Storage for Annotated<T, S>

async fn open(opts: StorageOpenOptions) -> Result<Self>

Open a storage object.

fn open_sync(opts: StorageOpenOptions) -> Result<Self>

Synchronous wrapper around Storage::open().

async fn create_open(opts: StorageCreateOptions) -> Result<Self>

Create a storage object and open it.

fn mem_align(&self) -> usize

Minimum required alignment for memory buffers.

fn req_align(&self) -> usize

Minimum required alignment for offsets and lengths.

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

Storage object length.

fn resolve_relative_path<P: AsRef<Path>>(&self, relative: P) -> Result<PathBuf>

Resolve the given path relative to this storage object.

fn get_filename(&self) -> Option<PathBuf>

Return a filename, if possible.

async unsafe fn pure_readv( &self, bufv: IoVectorMut<'_>, offset: u64, ) -> Result<()>

Read data at offset into bufv.

async unsafe fn pure_writev( &self, bufv: IoVector<'_>, offset: u64, ) -> Result<()>

Write data from bufv to offset.

async unsafe fn pure_write_zeroes(&self, offset: u64, length: u64) -> Result<()>

Ensure the given range reads back as zeroes.

async unsafe fn pure_discard(&self, offset: u64, length: u64) -> Result<()>

Discard the given range, with undefined contents when read back.

async fn flush(&self) -> Result<()>

Flush internal buffers.

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

Sync data already written to the storage hardware.

async unsafe fn invalidate_cache(&self) -> Result<()>

Drop internal buffers.

fn get_storage_helper(&self) -> &CommonStorageHelper

Return the storage helper object (used by the StorageExt implementation).

async fn resize( &self, new_size: u64, prealloc_mode: PreallocateMode, ) -> Result<()>

Resize to the given size.

async fn create(opts: StorageCreateOptions) -> Result<()>

Create a storage object.

fn zero_align(&self) -> usize

Minimum required alignment for zero writes.

fn discard_align(&self) -> usize

Minimum required alignment for effective discards.