pub struct ListBuilder { /* private fields */ }Expand description
A pending list, created with OxiaClient::list.
.await it for all matching keys at once (bounded by the request timeout),
or call stream for an incremental, ordered
ListStream without an overall deadline.
Implementations§
Source§impl ListBuilder
impl ListBuilder
Sourcepub fn partition_key(self, partition_key: impl Into<String>) -> Self
pub fn partition_key(self, partition_key: impl Into<String>) -> Self
Restricts the listing to the shard owning partition_key.
Sourcepub fn use_index(self, index_name: impl Into<String>) -> Self
pub fn use_index(self, index_name: impl Into<String>) -> Self
Lists keys from the named secondary index instead of the primary key space.
Sourcepub fn include_internal_keys(self, include: bool) -> Self
pub fn include_internal_keys(self, include: bool) -> Self
Also returns Oxia’s internal keys (hidden by default).
Sourcepub async fn stream(self) -> Result<ListStream, OxiaError>
pub async fn stream(self) -> Result<ListStream, OxiaError>
Opens an incremental, ordered stream of the matching keys.
Trait Implementations§
Source§impl Debug for ListBuilder
impl Debug for ListBuilder
Source§impl IntoFuture for ListBuilder
impl IntoFuture for ListBuilder
Source§type Output = Result<Vec<String>, OxiaError>
type Output = Result<Vec<String>, OxiaError>
The output that the future will produce on completion.
Source§type IntoFuture = Pin<Box<dyn Future<Output = <ListBuilder as IntoFuture>::Output> + Send>>
type IntoFuture = Pin<Box<dyn Future<Output = <ListBuilder as IntoFuture>::Output> + Send>>
Which kind of future are we turning this into?
Source§fn into_future(self) -> Self::IntoFuture
fn into_future(self) -> Self::IntoFuture
Creates a future from a value. Read more
Auto Trait Implementations§
impl !RefUnwindSafe for ListBuilder
impl !UnwindSafe for ListBuilder
impl Freeze for ListBuilder
impl Send for ListBuilder
impl Sync for ListBuilder
impl Unpin for ListBuilder
impl UnsafeUnpin for ListBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::Request