Struct mongodb_cursor_pagination::Edge

pub struct Edge(_);

Represents a Cursor to an Item with no special direction. To Debug the contents, use Debug When serializing or converting to String, the Edge gets encoded as url-safe Base64 String.

Implementations

impl Edge

pub fn new(document: Document, options: &CursorOptions) -> Self

Creates a new Edge using a value Document and the sorting keys. Only retains the values of the keys specified in the sort options to optimize storage.

Arguments

• document: The Item to which the Edge will point to
• options: Used to extract the sorting keys

Methods from Deref<Target = Document>

pub fn iter(&self) -> Iter<'_>

Gets an iterator over the entries of the map.

pub fn iter_mut(&mut self) -> IterMut<'_>

Gets an iterator over pairs of keys and mutable values.

pub fn clear(&mut self)

Clears the document, removing all values.

pub fn get(&self, key: impl AsRef<str>) -> Option<&Bson>

Returns a reference to the Bson corresponding to the key.

pub fn get_mut(&mut self, key: impl AsRef<str>) -> Option<&mut Bson>

Gets a mutable reference to the Bson corresponding to the key

pub fn get_f64(&self, key: impl AsRef<str>) -> Result<f64, ValueAccessError>

Get a floating point value for this key if it exists and has the correct type.

pub fn get_f64_mut( &mut self, key: impl AsRef<str> ) -> Result<&mut f64, ValueAccessError>

Get a mutable reference to a floating point value for this key if it exists and has the correct type.

pub fn get_decimal128( &self, key: impl AsRef<str> ) -> Result<&Decimal128, ValueAccessError>

Get a reference to a Decimal128 value for key, if it exists.

pub fn get_decimal128_mut( &mut self, key: impl AsRef<str> ) -> Result<&mut Decimal128, ValueAccessError>

Get a mutable reference to a Decimal128 value for key, if it exists.

pub fn get_str(&self, key: impl AsRef<str>) -> Result<&str, ValueAccessError>

Get a string slice this key if it exists and has the correct type.

pub fn get_str_mut( &mut self, key: impl AsRef<str> ) -> Result<&mut str, ValueAccessError>

Get a mutable string slice this key if it exists and has the correct type.

pub fn get_array( &self, key: impl AsRef<str> ) -> Result<&Vec<Bson, Global>, ValueAccessError>

Get a reference to an array for this key if it exists and has the correct type.

pub fn get_array_mut( &mut self, key: impl AsRef<str> ) -> Result<&mut Vec<Bson, Global>, ValueAccessError>

Get a mutable reference to an array for this key if it exists and has the correct type.

pub fn get_document( &self, key: impl AsRef<str> ) -> Result<&Document, ValueAccessError>

Get a reference to a document for this key if it exists and has the correct type.

pub fn get_document_mut( &mut self, key: impl AsRef<str> ) -> Result<&mut Document, ValueAccessError>

Get a mutable reference to a document for this key if it exists and has the correct type.

pub fn get_bool(&self, key: impl AsRef<str>) -> Result<bool, ValueAccessError>

Get a bool value for this key if it exists and has the correct type.

pub fn get_bool_mut( &mut self, key: impl AsRef<str> ) -> Result<&mut bool, ValueAccessError>

Get a mutable reference to a bool value for this key if it exists and has the correct type.

pub fn is_null(&self, key: impl AsRef<str>) -> bool

Returns wether this key has a null value

pub fn get_i32(&self, key: impl AsRef<str>) -> Result<i32, ValueAccessError>

Get an i32 value for this key if it exists and has the correct type.

pub fn get_i32_mut( &mut self, key: impl AsRef<str> ) -> Result<&mut i32, ValueAccessError>

Get a mutable reference to an i32 value for this key if it exists and has the correct type.

pub fn get_i64(&self, key: impl AsRef<str>) -> Result<i64, ValueAccessError>

Get an i64 value for this key if it exists and has the correct type.

pub fn get_i64_mut( &mut self, key: impl AsRef<str> ) -> Result<&mut i64, ValueAccessError>

Get a mutable reference to an i64 value for this key if it exists and has the correct type.

pub fn get_timestamp( &self, key: impl AsRef<str> ) -> Result<Timestamp, ValueAccessError>

Get a time stamp value for this key if it exists and has the correct type.

pub fn get_timestamp_mut( &mut self, key: impl AsRef<str> ) -> Result<&mut Timestamp, ValueAccessError>

Get a mutable reference to a time stamp value for this key if it exists and has the correct type.

pub fn get_binary_generic( &self, key: impl AsRef<str> ) -> Result<&Vec<u8, Global>, ValueAccessError>

Get a reference to a generic binary value for this key if it exists and has the correct type.

pub fn get_binary_generic_mut( &mut self, key: impl AsRef<str> ) -> Result<&mut Vec<u8, Global>, ValueAccessError>

Get a mutable reference generic binary value for this key if it exists and has the correct type.

pub fn get_object_id( &self, key: impl AsRef<str> ) -> Result<ObjectId, ValueAccessError>

Get an object id value for this key if it exists and has the correct type.

pub fn get_object_id_mut( &mut self, key: impl AsRef<str> ) -> Result<&mut ObjectId, ValueAccessError>

Get a mutable reference to an object id value for this key if it exists and has the correct type.

pub fn get_datetime( &self, key: impl AsRef<str> ) -> Result<&DateTime, ValueAccessError>

Get a reference to a UTC datetime value for this key if it exists and has the correct type.

pub fn get_datetime_mut( &mut self, key: impl AsRef<str> ) -> Result<&mut DateTime, ValueAccessError>

Get a mutable reference to a UTC datetime value for this key if it exists and has the correct type.

pub fn contains_key(&self, key: impl AsRef<str>) -> bool

Returns true if the map contains a value for the specified key.

pub fn keys(&self) -> Keys<'_>

Gets a collection of all keys in the document.

pub fn values(&self) -> Values<'_>

Gets a collection of all values in the document.

pub fn len(&self) -> usize

Returns the number of elements in the document.

pub fn is_empty(&self) -> bool

Returns true if the document contains no elements

pub fn insert<KT, BT>(&mut self, key: KT, val: BT) -> Option<Bson>where KT: Into<String>, BT: Into<Bson>,

Sets the value of the entry with the OccupiedEntry’s key, and returns the entry’s old value. Accepts any type that can be converted into Bson.

pub fn remove(&mut self, key: impl AsRef<str>) -> Option<Bson>

Takes the value of the entry out of the document, and returns it. Computes in O(n) time (average).

pub fn entry(&mut self, k: String) -> Entry<'_>

pub fn to_writer<W>(&self, writer: W) -> Result<(), Error>where W: Write,

Attempts to serialize the Document into a byte stream.

While the method signature indicates an owned writer must be passed in, a mutable reference may also be passed in due to blanket implementations of Write provided in the standard library.

use bson::doc;

let mut v: Vec<u8> = Vec::new();
let doc = doc! { "x" : 1 };
doc.to_writer(&mut v)?;

Trait Implementations

impl Clone for Edge

fn clone(&self) -> Edge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Edge

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

Formats the value using the given formatter.

impl Deref for Edge

type Target = Document

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Edge

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Edge

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

Deserialize this value from the given Serde deserializer.

impl Display for Edge

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

Formats the value using the given formatter.

impl PartialEq<Edge> for Edge

fn eq(&self, other: &Edge) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Edge

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Edge