Struct PageContext

pub struct PageContext {
    pub done: bool,
    pub token: String,
    pub entries: VecDeque<Entry>,
}

PageContext is the context passing between PageList.

PageLister will init the PageContext, and implementer of PageList should fill the PageContext based on their needs.

• Set done to true if all page have been fetched.
• Update token if there is more page to fetch. token is not exposed to users, it’s internal used only.
• Push back into the entries for each entry fetched from underlying storage.

NOTE: entries is a VecDeque to avoid unnecessary memory allocation. Only push_back is allowed.

Fields

done: bool

done is used to indicate whether the list operation is done.

token: String

token is used by underlying storage services to fetch next page.

entries: VecDeque<Entry>

entries are used to store entries fetched from underlying storage.

Please always reuse the same VecDeque to avoid unnecessary memory allocation. PageLister makes sure that entries is reset before calling next_page. Implementer can call push_back on entries directly.