TrackingStore

noosphere_storage

Struct TrackingStore 

Source 
pub struct TrackingStore<S: Store> { /* private fields */ }
Expand description

This is a store wrapper that tracks I/O. It is inspired by the testing utility originally created for the Forest HAMT implementation. This wrapper is all runtime overhead and should only be used for testing.

Implementations§

Source§

impl<S: Store> TrackingStore<S>

Source

pub async fn to_stats(&self) -> StoreStats

Source

pub fn wrap(store: S) -> Self

Trait Implementations§

Source§

impl<S: Clone + Store> Clone for TrackingStore<S>

Source§

fn clone(&self) -> TrackingStore<S>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<S: Debug + Store> Debug for TrackingStore<S>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<S: Store> Store for TrackingStore<S>

Source§

fn read<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read the bytes stored against a given key
Source§

fn write<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, key: &'life1 [u8], bytes: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Writes bytes to local storage against a given key, and returns the previous value stored against that key if any
Source§

fn remove<'life0, 'life1, 'async_trait>( &'life0 mut self, key: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove a value given a key, returning the removed value if any
Source§

fn flush<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Flushes pending writes if there are any

Auto Trait Implementations§

§

impl<S> Freeze for TrackingStore<S>
where S: Freeze,

§

impl<S> !RefUnwindSafe for TrackingStore<S>

§

impl<S> Send for TrackingStore<S>

§

impl<S> Sync for TrackingStore<S>

§

impl<S> Unpin for TrackingStore<S>
where S: Unpin,

§

impl<S> !UnwindSafe for TrackingStore<S>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<S> BlockStore for S
where S: Store,

Source§

fn put_block<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, cid: &'life1 Cid<64>, block: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, S: 'async_trait,

Given a block and its Cid, persist the block in storage.
Source§

fn get_block<'life0, 'life1, 'async_trait>( &'life0 self, cid: &'life1 Cid<64>, ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, S: 'async_trait,

Given the Cid of a block, retrieve the block bytes from storage.
Source§

fn flush<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, S: 'async_trait,

Flushes pending writes if there are any
Given a CID and a block, store the links (any Cid that is part of the encoded data) in a suitable location for later retrieval. This method is optional, and its default implementation is a no-op. It should be implemented when possible to enable optimized traversal of a DAG given its root.
Source§

fn put<'life0, 'async_trait, C, T>( &'life0 mut self, data: T, ) -> Pin<Box<dyn Future<Output = Result<Cid>> + Send + 'async_trait>>
where C: Codec + Default + 'async_trait, T: Encode<C> + ConditionalSend + 'async_trait, Ipld: References<C>, Self: Send + 'async_trait, 'life0: 'async_trait,

Given some data structure that implements Encode for a given Codec, encode it as a block and persist it to storage for later retrieval by Cid.
Source§

fn get<'life0, 'life1, 'async_trait, C, T>( &'life0 self, cid: &'life1 Cid, ) -> Pin<Box<dyn Future<Output = Result<Option<T>>> + Send + 'async_trait>>
where C: Codec + Default + 'async_trait, T: Decode<C> + 'async_trait, Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Given the Cid of a block that refers to a type that implements Decode for some Codec, retrieve the block, decode it as the type and return the result.
Source§

fn save<'life0, 'async_trait, C, T>( &'life0 mut self, data: T, ) -> Pin<Box<dyn Future<Output = Result<Cid>> + Send + 'async_trait>>
where C: Codec + Default + 'async_trait, T: Serialize + ConditionalSend + 'async_trait, Ipld: Encode<C> + References<C>, Self: Send + 'async_trait, 'life0: 'async_trait,

Given some data structure that implements Serialize, convert it to an IPLD-compatible representation, encode it as a block with the desired Codec and persist it to the storage backend by its Cid
Source§

fn load<'life0, 'life1, 'async_trait, C, T>( &'life0 self, cid: &'life1 Cid, ) -> Pin<Box<dyn Future<Output = Result<T>> + Send + 'async_trait>>
where C: Codec + Default + 'async_trait, T: DeserializeOwned + ConditionalSend + 'async_trait, u64: From<C>, Ipld: Decode<C>, Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Given a Cid that refers to some data structure that implements Deserialize, read the block bytes from storage, decode it as IPLD using the specified Codec and and deserialize it to the intended data structure, returning the result.
Source§

fn require_block<'life0, 'life1, 'async_trait>( &'life0 self, cid: &'life1 Cid, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Same as load, but returns an error if no block is found locally for the given Cid
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<S> KeyValueStore for S
where S: Store,

Source§

fn set_key<'life0, 'async_trait, K, V>( &'life0 mut self, key: K, value: V, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, K: AsRef<[u8]> + ConditionalSend + 'async_trait, V: Serialize + ConditionalSend + 'async_trait, S: 'async_trait,

Given some key that can be realized as bytes, persist a serializable value to storage so that it can later be retrieved by that key
Source§

fn unset_key<'life0, 'async_trait, K>( &'life0 mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, K: AsRef<[u8]> + ConditionalSend + 'async_trait, S: 'async_trait,

Given some key that can be realized as bytes, unset the value stored against that key (if any)
Source§

fn get_key<'life0, 'async_trait, K, V>( &'life0 self, key: K, ) -> Pin<Box<dyn Future<Output = Result<Option<V>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, K: AsRef<[u8]> + ConditionalSend + 'async_trait, V: DeserializeOwned + ConditionalSend + 'async_trait, S: 'async_trait,

Given some key that can be realized as bytes, retrieve some data that can be deserialized as the intended data structure
Source§

fn flush<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, S: 'async_trait,

Flushes pending writes if there are any
Source§

fn require_key<'life0, 'async_trait, K, V>( &'life0 self, key: K, ) -> Pin<Box<dyn Future<Output = Result<V>> + Send + 'async_trait>>
where K: AsRef<[u8]> + ConditionalSend + Display + 'async_trait, V: DeserializeOwned + ConditionalSend + 'async_trait, Self: Sync + 'async_trait, 'life0: 'async_trait,

Same as get_key, but returns an error if no value is found to be stored against the key
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> References<RawCodec> for T

Source§

fn references<R, E>(_c: RawCodec, _r: &mut R, _set: &mut E) -> Result<(), Error>
where R: Read, E: Extend<Cid<64>>,

Scrape the references from an impl Read. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<S> StoreContainsCid for S
where S: Store,

Source§

fn contains_cid<'life0, 'life1, 'async_trait>( &'life0 self, cid: &'life1 Cid<64>, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, S: 'async_trait,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S> ConditionalSend for S
where S: Send,

Source§

impl<S> ConditionalSync for S
where S: Send + Sync,

Source§

impl<U> UcanStoreConditionalSend for U
where U: Send,

Source§

impl<U> UcanStoreConditionalSendSync for U
where U: Send + Sync,