Struct elasticsearch::Scroll

source · [−]

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

Expand description

Builder for the Scroll API

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

Implementations

source

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

source

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

Creates a new instance of Scroll with the specified API parts

source

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

The body for the API call

source

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

Include the stack trace of returned errors.

source

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

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

Adds a HTTP header

source

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

Return human readable values for statistics.

source

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

Pretty format the returned JSON response.

source

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.

source

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

source

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

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

source

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

The scroll ID for scrolled search

source

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.

source

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

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

Trait Implementations

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<'a, 'b, B> !RefUnwindSafe for Scroll<'a, 'b, B>

impl<'a, 'b, B> Send for Scroll<'a, 'b, B> where
B: Send,

impl<'a, 'b, B> Sync for Scroll<'a, 'b, B> where
B: Sync,

impl<'a, 'b, B> Unpin for Scroll<'a, 'b, B> where
B: Unpin,

impl<'a, 'b, B> !UnwindSafe for Scroll<'a, 'b, B>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

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 for T where
U: From<T>,

const: unstable · 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::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

Struct elasticsearch::Scroll

Implementations

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

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

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

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

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

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

Auto Trait Implementations

impl<'a, 'b, B> !RefUnwindSafe for Scroll<'a, 'b, B>

impl<'a, 'b, B> Send for Scroll<'a, 'b, B> where B: Send,

impl<'a, 'b, B> Sync for Scroll<'a, 'b, B> where B: Sync,

impl<'a, 'b, B> Unpin for Scroll<'a, 'b, B> where B: Unpin,

impl<'a, 'b, B> !UnwindSafe for Scroll<'a, 'b, B>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> DynClone for T where T: Clone,

fn __clone_box(&self, Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

impl<'a, 'b, B> Send for Scroll<'a, 'b, B> where
B: Send,

impl<'a, 'b, B> Sync for Scroll<'a, 'b, B> where
B: Sync,

impl<'a, 'b, B> Unpin for Scroll<'a, 'b, B> where
B: Unpin,

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

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

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

impl<T> DynClone for T where
T: Clone,

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

impl<T> ToOwned for T where
T: Clone,

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

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

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