Skip to main content

PagedSearch

Struct PagedSearch 

Source
pub struct PagedSearch<'a> { /* private fields */ }
Expand description

Incremental paged search that yields one page of results at a time.

Created via Client::search_paged_stream. Call next_page repeatedly to fetch pages. If you stop before exhausting results, call cancel to release the server-side cookie.

Implementations§

Source§

impl<'a> PagedSearch<'a>

Source

pub async fn next_page( &mut self, ) -> Result<Option<Vec<SearchResultEntry>>, Error>

Fetch the next page of results.

Returns Ok(Some(entries)) for each page, Ok(None) when all pages have been consumed.

Source

pub async fn cancel(&mut self) -> Result<(), Error>

Send an abandon request (page size 0) to release the server cookie.

Call this if you stop iterating before all pages are consumed. If you don’t, the server cookie will eventually time out on its own (~120 s).

Source

pub fn is_done(&self) -> bool

Returns true once all pages have been consumed or cancel was called.

Auto Trait Implementations§

§

impl<'a> Freeze for PagedSearch<'a>

§

impl<'a> !RefUnwindSafe for PagedSearch<'a>

§

impl<'a> Send for PagedSearch<'a>

§

impl<'a> Sync for PagedSearch<'a>

§

impl<'a> Unpin for PagedSearch<'a>

§

impl<'a> UnsafeUnpin for PagedSearch<'a>

§

impl<'a> !UnwindSafe for PagedSearch<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more