Struct BatchListRequest 

pub struct BatchListRequest { /* private fields */ }

Validated batch-list pagination request.

Pagination cursors are opaque provider-owned values; a requested limit is not a guarantee that every provider supports the same pagination controls.

Examples

use providers_kit::batch::BatchListRequest;
let request = BatchListRequest::default()
    .with_limit(std::num::NonZeroUsize::new(10).unwrap())
    .with_cursor("opaque-next")?;
assert_eq!(request.limit().unwrap().get(), 10);
assert_eq!(request.cursor(), Some("opaque-next"));

Implementations

impl BatchListRequest

pub fn with_limit(self, limit: NonZeroUsize) -> Self

Sets a non-zero result limit.

See crate::batch::BatchListRequest for a complete example.

pub fn with_cursor(self, cursor: impl Into<String>) -> Result<Self, KitError>

Sets a non-empty provider-native continuation cursor.

Errors

Returns an input error when the cursor is empty or whitespace-only. Nonblank cursor bytes are retained exactly; use only a cursor returned by the same provider operation.

See crate::batch::BatchListRequest for a complete example.

pub const fn limit(&self) -> Option<NonZeroUsize>

Returns the requested result limit.

See crate::batch::BatchListRequest for a complete example.

pub fn cursor(&self) -> Option<&str>

Returns the provider-native continuation cursor.

See crate::batch::BatchListRequest for a complete example.

pub fn into_parts(self) -> (Option<NonZeroUsize>, Option<String>)

Consumes the request into its limit and continuation cursor.

Examples

use providers_kit::batch::BatchListRequest;
let request = BatchListRequest::default()
    .with_limit(std::num::NonZeroUsize::new(10).unwrap())
    .with_cursor("opaque-next")?;
let (limit, cursor) = request.into_parts();
assert_eq!(limit.unwrap().get(), 10);
assert_eq!(cursor.as_deref(), Some("opaque-next"));

Trait Implementations

impl Clone for BatchListRequest

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 BatchListRequest

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

Formats the value using the given formatter.

impl Default for BatchListRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BatchListRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BatchListRequest

impl PartialEq for BatchListRequest

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for BatchListRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BatchListRequest