Skip to main content

QueryMinimizingExplorer

Struct QueryMinimizingExplorer 

Source
pub struct QueryMinimizingExplorer<E: BlockchainExplorer> { /* private fields */ }
Expand description

Wraps any BlockchainExplorer with caching and rate limiting to reduce redundant API calls to the underlying explorer.

Implementations§

Source§

impl<E: BlockchainExplorer> QueryMinimizingExplorer<E>

Source

pub fn new(inner: E, config: QueryMinimizationConfig) -> Self

Create a new QueryMinimizingExplorer wrapping inner.

Source

pub fn query_count(&self) -> u64

Total number of queries forwarded to the inner explorer.

Source

pub fn cache_hit_count(&self) -> u64

Total number of cache hits (queries served from cache).

Source

pub fn cache_hit_rate(&self) -> f64

Fraction of all requests served from cache: cache_hits / (cache_hits + queries).

Returns 0.0 if no requests have been made yet.

Source

pub fn evict_expired(&self)

Remove expired entries from both caches.

Trait Implementations§

Source§

impl<E: BlockchainExplorer> BlockchainExplorer for QueryMinimizingExplorer<E>

Source§

fn get_transaction<'life0, 'life1, 'async_trait>( &'life0 self, txid: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<ExplorerTransaction, BitcoinError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieve a transaction by its txid.
Source§

fn get_address_info<'life0, 'life1, 'async_trait>( &'life0 self, address: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<ExplorerAddress, BitcoinError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieve address metadata and balance.
Source§

fn get_utxos<'life0, 'life1, 'async_trait>( &'life0 self, address: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<ExplorerUtxo>, BitcoinError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieve the unspent outputs for an address.
Source§

fn broadcast_transaction<'life0, 'life1, 'async_trait>( &'life0 self, hex: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<String, BitcoinError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Broadcast a raw transaction (hex-encoded) to the network. Read more
Source§

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

Return the current confirmed block height.

Auto Trait Implementations§

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<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> 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<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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