Skip to main content

TokenPager

Struct TokenPager 

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

Walks every page of GET /tokens, one request at a time.

Built with FyuzClient::token_pages. The pager starts at the page in the ListTokensParams it was given (or page 1) and stops as soon as the server’s tokenCount is covered or a page comes back empty — so it terminates even if the total shifts while you are walking it.

This is a plain async iterator rather than a futures::Stream: the crate has no futures dependency, and while let Some(..) = pager.next_*().await? reads the same.

use fyuz::{FyuzClient, ListTokensParams, SortDirection};

let client = FyuzClient::new()?;
let mut pager = client.token_pages(
    &ListTokensParams::new()
        .order_type("marketcap")
        .order_flag(SortDirection::Desc)
        .page_size(100),
);

// Page at a time…
while let Some(page) = pager.next_page().await? {
    println!("{} tokens (of {:?} total)", page.len(), pager.total_count());
}
// …or token at a time, with paging handled underneath.
let mut pager = client.token_pages(&ListTokensParams::new());
while let Some(token) = pager.next_token().await? {
    println!("{}", token.token_symbol);
}

Implementations§

Source§

impl TokenPager

Source

pub fn total_count(&self) -> Option<i64>

Total matching rows, as reported by the last page fetched. None before the first request.

Source

pub fn fetched_count(&self) -> i64

Rows yielded so far.

Source

pub async fn next_page(&mut self) -> Result<Option<Vec<Token>>>

Fetch the next page. Returns None once every page has been walked.

Source

pub async fn next_token(&mut self) -> Result<Option<Token>>

Yield the next token, fetching a page whenever the buffer runs dry.

Source

pub async fn collect_all(&mut self) -> Result<Vec<Token>>

Walk every remaining page and collect the lot.

Bounded by the server’s tokenCount; on a busy deployment that is still thousands of rows and dozens of requests, so prefer next_page if you can stream instead.

Trait Implementations§

Source§

impl Debug for TokenPager

Source§

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

Formats the value using the given formatter. Read more

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: Sized + 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: Sized + 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<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