Struct ListMeta 

pub struct ListMeta {
    pub total: Option<u64>,
    pub truncated: Option<bool>,
    pub next: Option<String>,
}

What a list result knows about itself beyond the rows.

Carried separately from the rows because the tabular formats have nowhere to put it, and because a caller that never paginated should not have to invent values it does not have.

Fields

total: Option<u64>

The server’s own count of matching items, where it reports one.

Usually absent. Jira’s /search/jql returns no total, and Bitbucket omits size on collections it considers expensive. Absent is not zero, and it is serialized as absent rather than as 0 for that reason.

truncated: Option<bool>

Whether the rows are a complete answer, when the caller knows.

None means unknown, and is serialized as absent rather than as false. Most list commands are still a single request against a server-paginated endpoint: they cannot tell whether more exists, and asserting truncated: false there would be a confident false claim of exactly the kind this field was added to prevent.

next: Option<String>

An opaque marker for where a truncated result stopped, when the source provides one.

Implementations

impl ListMeta

pub fn unknown() -> Self

What a caller that did not paginate knows: nothing.

Deliberately not called complete(). The callers that use it have not established completeness, and naming it so invited the envelope to assert it.

pub fn known(total: Option<u64>, truncated: bool, next: Option<String>) -> Self

A result whose completeness has been established.

Trait Implementations

impl Clone for ListMeta

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListMeta

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

Formats the value using the given formatter.

impl Default for ListMeta

fn default() -> Self

Returns the “default value” for a type.