Struct PaginationArgs 

pub struct PaginationArgs {
    pub limit: Option<usize>,
    pub offset: Option<usize>,
}

Shared pagination arguments for commands that support limiting results.

This group provides consistent limit/offset behavior across commands that return multiple results (search, list, history, etc.).

Usage

Flatten into command structs:

#[derive(Args)]
struct SearchArgs {
    #[command(flatten)]
    pagination: PaginationArgs,
    // ... other args
}

Examples

blz search "async" --limit 10
blz search "async" --limit 10 --offset 20
blz list --limit 5

Fields

limit: Option<usize>

Maximum number of results to return

Limits the output to the specified count. Must be at least 1.

offset: Option<usize>

Number of results to skip before returning

Used for paginating through large result sets.

Implementations

impl PaginationArgs

pub const fn with_limit(limit: usize) -> Self

Create pagination args with a specific limit.

pub const fn with_limit_and_offset(limit: usize, offset: usize) -> Self

Create pagination args with limit and offset.

pub const fn limit_or(&self, default: usize) -> usize

Get the effective limit, falling back to a default if not specified.

pub const fn offset_or_default(&self) -> usize

Get the effective offset, defaulting to 0 if not specified.

Trait Implementations

impl Args for PaginationArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for PaginationArgs

fn clone(&self) -> PaginationArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaginationArgs

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

Formats the value using the given formatter.

impl Default for PaginationArgs

fn default() -> PaginationArgs

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PaginationArgs

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for PaginationArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl PartialEq for PaginationArgs

fn eq(&self, other: &PaginationArgs) -> 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 Serialize for PaginationArgs

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PaginationArgs

impl StructuralPartialEq for PaginationArgs