Struct Page 

pub struct Page<T: Clone> {
    pub href: String,
    pub limit: u32,
    pub next: Option<String>,
    pub offset: u32,
    pub previous: Option<String>,
    pub total: u32,
    pub items: Vec<Option<T>>,
}

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

To get the rest of the data, the fields of this struct, or, preferably, some methods can be used to get the next or previous page, or the remaining or all items.

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. For pagination, see get_next.

offset: u32

The offset of the returned items.

previous: Option<String>

The URL to the previous page. For pagination, see get_previous.

total: u32

The amount of returned items.

items: Vec<Option<T>>

A list of the items, which includes null values. To get only the Some values, use filtered_items.

Implementations

impl<T: Clone + DeserializeOwned> Page<T>

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

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

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

Get the next page.

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

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

Get the previous page.

If there is no previous 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>>>

Get the items of all of the pages - that is, all the pages found both before and after the current one.

Trait Implementations

impl<T: Clone + Clone> Clone for Page<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Clone> Debug for Page<T>

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

Formats the value using the given formatter.

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

where T: Deserialize<'de> + Clone,

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> PartialEq for Page<T>

fn eq(&self, other: &Page<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: Clone> StructuralPartialEq for Page<T>