Struct CursorPage 

pub struct CursorPage<T: Clone, E: Endpoint + Default> {
    pub href: String,
    pub limit: u32,
    pub next: Option<String>,
    pub cursors: Option<Cursor>,
    pub total: Option<u32>,
    pub items: Vec<Option<T>>,
    /* private fields */
}

This represents a page of items, which is a segment of data returned by the Spotify API.

It’s similar to Page, except that it uses a different approach for pagination - instead of using a next and previous field to get another page, it uses a Unix timestamp (in miliseconds).

To get the rest of the data, the cursors field (and others), or, preferably, the get_before and get_after methods can be used.

Fields

href: String

The URL to the API endpoint returning this page.

limit: u32

The maximum amount of items in the response.

next: Option<String>

The URL to the next page.

cursors: Option<Cursor>

The cursor object used to get the previous/next page.

total: Option<u32>

The amount of returned items.

items: Vec<Option<T>>

A list of the items, which includes null values.

Implementations

impl<T: Clone + DeserializeOwned, E: Endpoint + Default + Clone> CursorPage<T, E>

pub fn filtered_items(&self) -> Vec<T>

Get a list of only the Some values from a Cursor Page’s items.

pub async fn get_before( &self, spotify: &Client<Token, impl AuthFlow>, ) -> Result<Self>

Get the page chronologically before the current one.

If there is no previous page, this will return an Error::NoRemainingPages.

pub async fn get_after( &self, spotify: &Client<Token, impl AuthFlow>, ) -> Result<Self>

Get the page chronologically after the current one.

If there is no next page, this will return an Error::NoRemainingPages.

pub async fn get_remaining( self, spotify: &Client<Token, impl AuthFlow>, ) -> Result<Vec<Option<T>>>

Get the items of all the remaining pages - that is, all the pages found after the current one.

pub async fn get_all( self, spotify: &Client<Token, impl AuthFlow>, ) -> Result<Vec<Option<T>>>

Trait Implementations

impl<T: Clone + Clone, E: Clone + Endpoint + Default> Clone for CursorPage<T, E>

fn clone(&self) -> CursorPage<T, E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Clone, E: Debug + Endpoint + Default> Debug for CursorPage<T, E>

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

Formats the value using the given formatter.

impl<'de, T, E> Deserialize<'de> for CursorPage<T, E>

where T: Deserialize<'de> + Clone, E: Default + Endpoint + Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq + Clone, E: PartialEq + Endpoint + Default> PartialEq for CursorPage<T, E>

fn eq(&self, other: &CursorPage<T, E>) -> 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: Clone, E: Endpoint + Default> StructuralPartialEq for CursorPage<T, E>