Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

Internal client to handle http requests and retries.

Implementations§

Source§

impl Client

Source

pub fn new(cfg: ClientConfig) -> Result<Self>

Creates a new client with the given configuration.

Source

pub async fn collect( self: Arc<Self>, query: Query, config: StreamConfig, ) -> Result<QueryResponse>

Retrieves blocks, transactions, traces, and logs through a stream using the provided query and stream configuration.

§Implementation

Runs multiple queries simultaneously based on config.concurrency.

Each query runs until it reaches query.to, server height, any max_num_* query param, or execution timed out by server.

Source

pub async fn collect_events( self: Arc<Self>, query: Query, config: StreamConfig, ) -> Result<QueryResponse<Vec<Event>>>

Retrieves events through a stream using the provided query and stream configuration.

Source

pub async fn collect_arrow( self: Arc<Self>, query: Query, config: StreamConfig, ) -> Result<ArrowResponse>

Retrieves blocks, transactions, traces, and logs in Arrow format through a stream using the provided query and stream configuration.

Source

pub async fn collect_parquet( self: Arc<Self>, path: &str, query: Query, config: StreamConfig, ) -> Result<()>

Writes parquet file getting data through a stream using the provided path, query, and stream configuration.

Source

pub async fn get_chain_id(&self) -> Result<u64>

Get the chain_id from the server with retries.

Source

pub async fn get_height(&self) -> Result<u64>

Get the height of from server with retries.

Source

pub async fn health_check( &self, http_req_timeout: Option<Duration>, ) -> Result<u64>

Get the height of the Client instance for health checks. Doesn’t do any retries and the http_req_timeout parameter will override the http timeout config set when creating the client.

Source

pub async fn get(&self, query: &Query) -> Result<QueryResponse>

Executes query with retries and returns the response.

Source

pub async fn get_events( &self, query: Query, ) -> Result<QueryResponse<Vec<Event>>>

Add block, transaction and log fields selection to the query, executes it with retries and returns the response.

Source

pub async fn get_arrow(&self, query: &Query) -> Result<ArrowResponse>

Executes query with retries and returns the response in Arrow format.

Source

pub async fn stream( self: Arc<Self>, query: Query, config: StreamConfig, ) -> Result<Receiver<Result<QueryResponse>>>

Spawns task to execute query and return data via a channel.

Source

pub async fn stream_events( self: Arc<Self>, query: Query, config: StreamConfig, ) -> Result<Receiver<Result<QueryResponse<Vec<Event>>>>>

Add block, transaction and log fields selection to the query and spawns task to execute it, returning data via a channel.

Source

pub async fn stream_arrow( self: Arc<Self>, query: Query, config: StreamConfig, ) -> Result<Receiver<Result<ArrowResponse>>>

Spawns task to execute query and return data via a channel in Arrow format.

Source

pub fn url(&self) -> &Url

Getter for url field.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

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 Debug for Client

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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> 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> 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> 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<T> ErasedDestructor for T
where T: 'static,