Struct elasticsearch::Scroll

pub struct Scroll<'a, 'b, B> { /* private fields */ }

Builder for the Scroll API

Allows to retrieve a large numbers of results from a single search request.

Implementations

impl<'a, 'b, B> Scroll<'a, 'b, B>where
    B: Body,

pub fn new(transport: &'a Transport, parts: ScrollParts<'b>) -> Self

Creates a new instance of Scroll with the specified API parts

pub fn body<T>(self, body: T) -> Scroll<'a, 'b, JsonBody<T>>where
    T: Serialize,

The body for the API call

pub fn error_trace(self, error_trace: bool) -> Self

Include the stack trace of returned errors.

pub fn filter_path(self, filter_path: &'b [&'b str]) -> Self

A comma-separated list of filters used to reduce the response.

pub fn header(self, key: HeaderName, value: HeaderValue) -> Self

Adds a HTTP header

pub fn human(self, human: bool) -> Self

Return human readable values for statistics.

pub fn pretty(self, pretty: bool) -> Self

Pretty format the returned JSON response.

pub fn request_timeout(self, timeout: Duration) -> Self

Sets a request timeout for this API call.

The timeout is applied from when the request starts connecting until the response body has finished.

pub fn rest_total_hits_as_int(self, rest_total_hits_as_int: bool) -> Self

Indicates whether hits.total should be rendered as an integer or an object in the rest search response

pub fn scroll(self, scroll: &'b str) -> Self

Specify how long a consistent view of the index should be maintained for scrolled search

pub fn scroll_id(self, scroll_id: &'b str) -> Self

The scroll ID for scrolled search

pub fn source(self, source: &'b str) -> Self

The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

pub async fn send(self) -> Result<Response, Error>

Creates an asynchronous call to the Scroll API that can be awaited

Trait Implementations

impl<'a, 'b, B: Clone> Clone for Scroll<'a, 'b, B>

fn clone(&self) -> Scroll<'a, 'b, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, 'b, B: Debug> Debug for Scroll<'a, 'b, B>

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

Formats the value using the given formatter.