Struct Paginator 

#[non_exhaustive]
pub struct Paginator<T> {
    pub count: Option<u64>,
    pub items: Vec<T>,
    pub ctoken: Option<String>,
    pub visitor_data: Option<String>,
    pub endpoint: ContinuationEndpoint,
    pub authenticated: bool,
}

Wrapper around progressively fetched items

The paginator is a wrapper around a list of items that are fetched in pages from the YouTube API (e.g. playlist items, video recommendations or comments).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

count: Option<u64>

Total number of items if finite and known.

Note that this number may not be 100% accurate, as this is the number returned by the YouTube API at the initial fetch.

It is intended to be shown to the user (e.g. 1261 comments, 18 Videos) and for progress estimation.

Don’t use this number to check if all items were fetched or for iterating over the items.

items: Vec<T>

Content of the paginator

ctoken: Option<String>

The continuation token is passed to the YouTube API to fetch more items.

If it is None, it means that no more items can be fetched.

visitor_data: Option<String>

YouTube visitor data. Required for fetching the startpage

endpoint: ContinuationEndpoint

YouTube API endpoint to fetch continuations from

authenticated: bool

True if the paginator should be fetched with YouTube credentials

Implementations

impl<T: FromYtItem> Paginator<T>

pub async fn next<Q: AsRef<RustyPipeQuery>>( &self, query: Q, ) -> Result<Option<Self>, Error>

Get the next page from the paginator (or None if the paginator is exhausted)

pub async fn extend<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, ) -> Result<bool, Error>

Extend the items of the paginator by the next page

Returns false if the paginator is exhausted.

pub async fn extend_pages<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, n_pages: usize, ) -> Result<(), Error>

Extend the items of the paginator by the given amount of pages or until the paginator is exhausted.

pub async fn extend_limit<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, n_items: usize, ) -> Result<(), Error>

Extend the items of the paginator until the given amount of items is reached or the paginator is exhausted.

pub async fn extend_all<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, ) -> Result<(), Error>

Extend the items of the paginator until the paginator is exhausted.

impl Paginator<Comment>

pub async fn next<Q: AsRef<RustyPipeQuery>>( &self, query: Q, ) -> Result<Option<Self>, Error>

Get the next page from the paginator (or None if the paginator is exhausted)

impl Paginator<HistoryItem<VideoItem>>

pub async fn next<Q: AsRef<RustyPipeQuery>>( &self, query: Q, ) -> Result<Option<Self>, Error>

Available on crate feature userdata only.

Get the next page from the paginator (or None if the paginator is exhausted)

impl Paginator<HistoryItem<TrackItem>>

pub async fn next<Q: AsRef<RustyPipeQuery>>( &self, query: Q, ) -> Result<Option<Self>, Error>

Available on crate feature userdata only.

Get the next page from the paginator (or None if the paginator is exhausted)

impl Paginator<Comment>

pub async fn extend<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, ) -> Result<bool, Error>

Extend the items of the paginator by the next page

Returns false if the paginator is exhausted.

pub async fn extend_pages<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, n_pages: usize, ) -> Result<(), Error>

Extend the items of the paginator by the given amount of pages or until the paginator is exhausted.

pub async fn extend_limit<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, n_items: usize, ) -> Result<(), Error>

Extend the items of the paginator until the given amount of items is reached or the paginator is exhausted.

pub async fn extend_all<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, ) -> Result<(), Error>

Extend the items of the paginator until the paginator is exhausted.

impl Paginator<HistoryItem<VideoItem>>

pub async fn extend<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, ) -> Result<bool, Error>

Extend the items of the paginator by the next page

Returns false if the paginator is exhausted.

pub async fn extend_pages<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, n_pages: usize, ) -> Result<(), Error>

Extend the items of the paginator by the given amount of pages or until the paginator is exhausted.

pub async fn extend_limit<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, n_items: usize, ) -> Result<(), Error>

Extend the items of the paginator until the given amount of items is reached or the paginator is exhausted.

pub async fn extend_all<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, ) -> Result<(), Error>

Extend the items of the paginator until the paginator is exhausted.

impl Paginator<HistoryItem<TrackItem>>

pub async fn extend<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, ) -> Result<bool, Error>

Extend the items of the paginator by the next page

Returns false if the paginator is exhausted.

pub async fn extend_pages<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, n_pages: usize, ) -> Result<(), Error>

Extend the items of the paginator by the given amount of pages or until the paginator is exhausted.

pub async fn extend_limit<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, n_items: usize, ) -> Result<(), Error>

Extend the items of the paginator until the given amount of items is reached or the paginator is exhausted.

pub async fn extend_all<Q: AsRef<RustyPipeQuery>>( &mut self, query: Q, ) -> Result<(), Error>

Extend the items of the paginator until the paginator is exhausted.

impl<T> Paginator<T>

pub fn is_exhausted(&self) -> bool

Check if the paginator is exhausted, meaning that no more items can be fetched.

Equivalent to paginator.ctoken.is_none().

pub fn is_empty(&self) -> bool

Check if the paginator does not contain any data, meaning that it is exhausted and does not contain any items.

Trait Implementations

impl<T: Clone> Clone for Paginator<T>

fn clone(&self) -> Paginator<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Paginator<T>

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

Formats the value using the given formatter.

impl<T> Default for Paginator<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Paginator<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for Paginator<T>

fn eq(&self, other: &Paginator<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for Paginator<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for Paginator<T>

impl<T> StructuralPartialEq for Paginator<T>