Struct Client

pub struct Client {
    pub http_client: Client,
    pub subgraph_url: Url,
    pub auth_token: Option<String>,
    /* private fields */
}

A client for interacting with a subgraph.

Fields

http_client: Client

subgraph_url: Url

auth_token: Option<String>

The request authentication bearer token.

This is token is inserted in the Authentication header.

Implementations

impl Client

pub fn new(http_client: Client, subgraph_url: Url) -> Self

Create a new client with default settings.

The default settings are:

• No authentication token
• Latest block number of 0

pub fn builder(http_client: Client, subgraph_url: Url) -> ClientBuilder

Create a new client builder.

The builder allows for configuring the client before building it.

Example:

let client = SubgraphClient::builder(http_client, subgraph_url)
    .with_auth_token(Some(auth))
    .with_subgraph_latest_block(18627000)
    .build();

pub async fn query<T>( &self, query: impl IntoRequestParameters + Send, ) -> Result<T, String>

where T: for<'de> Deserialize<'de>,

Send a query to the subgraph.

pub async fn paginated_query<T>( &self, query: impl IntoDocument + Clone, page_size: usize, ) -> Result<Vec<T>, PaginatedQueryError>

where T: for<'de> Deserialize<'de>,

Send a paginated query to the subgraph.

The query is sent with a page size of page_size and the latest block number that the subgraph has progressed to.

In the case of a reorg, the function will return an error.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.