Struct StateListRequest 

pub struct StateListRequest { /* private fields */ }

Key-ordered namespace list request.

Results use ascending lexicographic UTF-8 key order within one exact namespace. The optional prefix is literal and case-sensitive; the cursor is exclusive. Each page has a consistent read view, but separate pages are not a historical snapshot. The default page size is 100; accepted sizes are 1 through 1000 inclusive.

Examples

use storage_kit::state::record::{StateKeyPrefix, StateListRequest};
let request = StateListRequest::new("workflow")?
    .with_key_prefix(StateKeyPrefix::new("run/")?)
    .with_limit(25)?
    .start_after("run/10")?;
assert_eq!(request.prefix(), Some("run/"));
assert_eq!(request.start_after_key(), Some("run/10"));

Implementations

impl StateListRequest

pub const DEFAULT_LIMIT: usize = DEFAULT_LIST_LIMIT

Default page size.

pub const MAX_LIMIT: usize = MAX_LIST_LIMIT

Maximum page size.

pub fn new(namespace: impl Into<String>) -> Result<Self, StateStoreError>

Creates a namespace-scoped request.

The new request has no prefix or cursor and uses Self::DEFAULT_LIMIT.

Errors

Returns StateStoreError::InvalidRequest when the namespace does not satisfy StateNamespace::new.

Examples

use storage_kit::state::record::StateListRequest;
let request = StateListRequest::new("workflow")?;
assert_eq!(request.limit(), StateListRequest::DEFAULT_LIMIT);
assert_eq!(request.start_after_key(), None);

pub fn with_key_prefix(self, prefix: StateKeyPrefix) -> Self

Restricts results to a validated key prefix.

Examples

use storage_kit::state::record::{StateKeyPrefix, StateListRequest};
let request = StateListRequest::new("workflow")?
    .with_key_prefix(StateKeyPrefix::new("run/%")?);
assert_eq!(request.prefix(), Some("run/%"));

pub fn with_limit(self, limit: usize) -> Result<Self, StateStoreError>

Replaces the page size.

Errors

Returns StateStoreError::InvalidRequest unless limit is between 1 and Self::MAX_LIMIT inclusive.

Examples

use storage_kit::state::record::StateListRequest;
let request = StateListRequest::new("workflow")?.with_limit(25)?;
assert_eq!(request.limit(), 25);
assert!(StateListRequest::new("workflow")?.with_limit(0).is_err());

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

Sets the namespace-local exclusive cursor.

Pass the previous response’s next_start_after unchanged with the same namespace and prefix. The cursor need not name a record that still exists.

Errors

Returns StateStoreError::InvalidRequest for an empty cursor, more than 1024 UTF-8 bytes, surrounding whitespace, or a control character.

Examples

use storage_kit::state::record::StateListRequest;
let request = StateListRequest::new("workflow")?.start_after("run/10")?;
assert_eq!(request.start_after_key(), Some("run/10"));

pub fn namespace(&self) -> &StateNamespace

Returns the namespace.

Examples

use storage_kit::state::record::StateListRequest;
let request = StateListRequest::new("workflow")?;
assert_eq!(request.namespace().as_str(), "workflow");

pub fn key_prefix(&self) -> Option<&StateKeyPrefix>

Returns the optional typed prefix.

Examples

use storage_kit::state::record::{StateKeyPrefix, StateListRequest};
let prefix = StateKeyPrefix::new("run/")?;
let request = StateListRequest::new("workflow")?.with_key_prefix(prefix.clone());
assert_eq!(request.key_prefix(), Some(&prefix));

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

Returns the optional prefix string.

Examples

use storage_kit::state::record::StateListRequest;
let request = StateListRequest::new("workflow")?;
assert_eq!(request.prefix(), None);

pub fn limit(&self) -> usize

Returns the page size.

Examples

use storage_kit::state::record::StateListRequest;
let request = StateListRequest::new("workflow")?.with_limit(12)?;
assert_eq!(request.limit(), 12);

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

Returns the optional cursor.

Examples

use storage_kit::state::record::StateListRequest;
let request = StateListRequest::new("workflow")?.start_after("run/1")?;
assert_eq!(request.start_after_key(), Some("run/1"));

Trait Implementations

impl Clone for StateListRequest

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 StateListRequest

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

Formats the value using the given formatter.