Struct AnyProvider

pub struct AnyProvider<Types>
where
    Types: NodeType,
{
    payload_providers: Vec<Arc<dyn DebugProvider<Types, PayloadRequest>>>,
    leaf_providers: Vec<Arc<dyn DebugProvider<Types, LeafRequest<Types>>>>,
    vid_common_providers: Vec<Arc<dyn DebugProvider<Types, VidCommonRequest>>>,
}

Adaptor combining multiple data availability providers.

This provider adaptor implements the Provider protocol by fetching requested objects from several different underlying providers. If any of the underlying sources have the object, the request will eventually succeed.

This can be used to combine multiple instances of the same kind of provider, like using QueryServiceProvider to request objects from a number of different query services. It can also be used to search different kinds of data providers for the same object, like searching for a block both in another instance of the query service and in the HotShot DA committee. Finally, AnyProvider can be used to combine a provider which only provides blocks and one which only provides leaves into a provider which provides both, and thus can be used as a provider for the availability API module.

Examples

Fetching from multiple query services, for resiliency.

use hotshot_query_service::{
    fetching::provider::{AnyProvider, QueryServiceProvider},
    testing::mocks::MockBase,
};

let qs1 = QueryServiceProvider::new("https://backup.query-service.1".parse()?, MockBase::instance());
let qs2 = QueryServiceProvider::new("https://backup.query-service.2".parse()?, MockBase::instance());
let provider = AnyProvider::<Types>::default()
    .with_provider(qs1)
    .with_provider(qs2);

Fields

payload_providers: Vec<Arc<dyn DebugProvider<Types, PayloadRequest>>>

leaf_providers: Vec<Arc<dyn DebugProvider<Types, LeafRequest<Types>>>>

vid_common_providers: Vec<Arc<dyn DebugProvider<Types, VidCommonRequest>>>

Implementations

impl<Types> AnyProvider<Types>

where Types: NodeType,

pub fn with_provider<P>(self, provider: P) -> Self

where P: AvailabilityProvider<Types> + Debug + 'static,

Add a sub-provider which fetches both blocks and leaves.

pub fn with_block_provider<P>(self, provider: P) -> Self

where P: Provider<Types, PayloadRequest> + Debug + 'static,

Add a sub-provider which fetches blocks.

pub fn with_leaf_provider<P>(self, provider: P) -> Self

where P: Provider<Types, LeafRequest<Types>> + Debug + 'static,

Add a sub-provider which fetches leaves.

pub fn with_vid_common_provider<P>(self, provider: P) -> Self

where P: Provider<Types, VidCommonRequest> + Debug + 'static,

Add a sub-provider which fetches VID common data.

Trait Implementations

impl<Types> Clone for AnyProvider<Types>

where Types: NodeType,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Types> Debug for AnyProvider<Types>

where Types: NodeType,

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

Formats the value using the given formatter.

impl<Types> Default for AnyProvider<Types>

where Types: NodeType,

fn default() -> Self

Returns the “default value” for a type.

impl<Types> Provider<Types, LeafRequest<Types>> for AnyProvider<Types>

where Types: NodeType,

fn fetch<'life0, 'async_trait>( &'life0 self, req: LeafRequest<Types>, ) -> Pin<Box<dyn Future<Output = Option<LeafQueryData<Types>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch a resource.

impl<Types> Provider<Types, PayloadRequest> for AnyProvider<Types>

where Types: NodeType,

fn fetch<'life0, 'async_trait>( &'life0 self, req: PayloadRequest, ) -> Pin<Box<dyn Future<Output = Option<Payload<Types>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch a resource.

impl<Types> Provider<Types, VidCommonRequest> for AnyProvider<Types>

where Types: NodeType,

fn fetch<'life0, 'async_trait>( &'life0 self, req: VidCommonRequest, ) -> Pin<Box<dyn Future<Output = Option<VidCommon>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch a resource.