Struct mongod::Sort

pub struct Sort<T: Field + Into<String>>(_);

A helper type to create a typed dictionary of sorted fields.

This type is used to sort documents fetched from the mongodb, it takes Field, Order pairs.

Example

Sorting a user collection by name.

use mongod::bson::Document;
use mongod::{AsField, Field, Order, Query, Sort};

#[mongo(collection="users", filter, update)]
#[derive(Bson, Mongo)]
pub struct User {
    pub name: String,
}

impl AsField<UserField> for User {}

pub enum UserField {
    Name,
}

impl Field for UserField {}

impl From<UserField> for String {
    fn from(field: UserField) -> String {
        match field {
            UserField::Name => "name".to_owned(),
        }
    }
}

let client = mongod::Client::default();

let mut sort = Sort::new();
sort.push(UserField::Name, Order::Asc);

let _cursor = Query::find::<User>()
    .sort(sort)
    .query(&client)
    .await
    .unwrap();

Implementations

impl<T: Field + Into<String>> Sort<T>

pub fn new() -> Self

Creates an empty Sort.

pub fn push(&mut self, field: T, order: Order<T>) -> &mut Self

Pushes a (Field, Order) pair into the sort.

pub fn into_document(self) -> Document

Converts the Sort into a BSON Document.

Trait Implementations

impl<T: Clone + Field + Into<String>> Clone for Sort<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Default for Sort<T> where
    T: Field + Into<String>, 

fn default() -> Self

Returns the “default value” for a type.

impl<T: Field + Into<String>> Serialize for Sort<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.