Struct octocrab::Page

#[non_exhaustive]
pub struct Page<T> {
    pub items: Vec<T>,
    pub incomplete_results: Option<bool>,
    pub total_count: Option<u64>,
    pub next: Option<Uri>,
    pub prev: Option<Uri>,
    pub first: Option<Uri>,
    pub last: Option<Uri>,
}

A Page of GitHub results, with links to the next and previous page.

let octocrab = octocrab::instance();

// Print the titles of the first page of issues.
for issue in octocrab.issues("rust-lang", "rust").list().send().await? {
    println!("{}", issue.title);
}

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.

items: Vec<T>

incomplete_results: Option<bool>

total_count: Option<u64>

next: Option<Uri>

prev: Option<Uri>

first: Option<Uri>

last: Option<Uri>

Implementations

impl<T> Page<T>

pub fn take_items(&mut self) -> Vec<T>

Returns the current set of items, replacing it with an empty Vec.

pub fn number_of_pages(&self) -> Option<u32>

If last is present, return the number of pages for this navigation.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T> Default for Page<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: DeserializeOwned> FromResponse for Page<T>

fn from_response<'async_trait, B>( response: Response<B> ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where B: Body<Data = Bytes, Error = Error> + Send + 'async_trait, Self: 'async_trait,

impl<'iter, T> IntoIterator for &'iter Page<T>

type Item = &'iter T

The type of the elements being iterated over.

type IntoIter = Iter<'iter, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for Page<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<<Page<T> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.