Struct ruarango::cursor::output::CursorMeta

pub struct CursorMeta<T> { /* private fields */ }

Cursor metadata output

Implementations

impl<T> CursorMeta<T>

pub fn id(&self) -> &Option<String>

id of temporary cursor created on the server

pub fn result(&self) -> &Option<Vec<T>>

An array of result documents (might be empty if query has no results)

pub fn extra(&self) -> &Option<Extra>

Extra information about the query result contained in its stats sub-attribute. For data-modification queries, the extra.stats sub-attribute will contain the number of modified documents and the number of documents that could not be modified due to an error if ignore_errors query option is specified

pub fn count(&self) -> &Option<usize>

The total number of result documents available (only available if the query was executed with the count attribute set)

pub fn code(&self) -> &u16

The HTTP status code

pub fn cached(&self) -> &bool

A boolean flag indicating whether the query result was served from the query cache or not. If the query result is served from the query cache, the extra return attribute will not contain any stats sub-attribute and no profile sub-attribute.

pub fn has_more(&self) -> &bool

A boolean indicator whether there are more results available for the cursor on the server

pub fn error(&self) -> &bool

A flag to indicate that an error occurred

Trait Implementations

impl<T: Clone> Clone for CursorMeta<T>

fn clone(&self) -> CursorMeta<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CursorMeta<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for CursorMeta<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.

impl<T> Serialize for CursorMeta<T>where
    T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.