Struct rs_es::operations::search::ScanResult

pub struct ScanResult<T> {
    pub scroll_id: String,
    pub took: u64,
    pub timed_out: bool,
    pub shards: ShardCountResult,
    pub hits: SearchHitsResult<T>,
    pub aggs: Option<AggregationsResult>,
}

Fields

scroll_id: String

took: u64

timed_out: bool

shards: ShardCountResult

hits: SearchHitsResult<T>

aggs: Option<AggregationsResult>

Methods

impl<T> ScanResult<T> where
    T: DeserializeOwned + Debug, 

Important traits for ScanIterator<'a, T>

impl<'a, T> Iterator for ScanIterator<'a, T> where
    T: DeserializeOwned + Debug,  type Item = Result<SearchHitsHitsResult<T>, EsError>;

pub fn iter(self, client: &mut Client, scroll: Duration) -> ScanIterator<T>

Returns an iterator from which hits can be read

pub fn scroll(
    &mut self,
    client: &mut Client,
    scroll: &Duration
) -> Result<SearchResult<T>, EsError>

Calls the /_search/scroll ES end-point for the next page

pub fn close(&self, client: &mut Client) -> Result<(), EsError>

Calls ES to close the server-side part of the scan/scroll operation

Trait Implementations

impl<T: Debug> Debug for ScanResult<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for ScanResult<T> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.