Struct redbot::query_listing::QueryListingRequest

pub struct QueryListingRequest<'a> {
    pub path: &'a str,
    pub params: &'a [(&'a str, &'a str)],
    pub after: Option<&'a str>,
    pub count: u64,
    pub limit: u64,
    pub requests: u64,
    pub show_all: bool,
}

Builder struct for constructing requests to a listing endpoint.

Fields

path: &'a str

The relative URL path

params: &'a [(&'a str, &'a str)]

The optional URL query parameters to supply

after: Option<&'a str>

The optional fullname to start at

count: u64

The number received so far

limit: u64

The number of items to get per request

requests: u64

The number of requests to make

show_all: bool

Wether to show all items (true) or follow hidden items settings (false)

Methods

impl<'a> QueryListingRequest<'a>

pub fn new(path: &'a str, limit: u64, requests: u64) -> Self

Construct a new builder.

pub fn path(self, path: &'a str) -> Self

Override the path field.

pub fn params(self, params: &'a [(&'a str, &'a str)]) -> Self

Override the params field.

pub fn after(self, after: Option<&'a str>) -> Self

Override the after field.

pub fn count(self, count: u64) -> Self

Override the count field.

pub fn limit(self, limit: u64) -> Self

Override the limit field.

pub fn requests(self, requests: u64) -> Self

Override the requests field.

pub fn show_all(self, show_all: bool) -> Self

Override the show_all field.

Trait Implementations

impl<'a> Clone for QueryListingRequest<'a>

fn clone(&self) -> QueryListingRequest<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for QueryListingRequest<'a>

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

Formats the value using the given formatter.