Struct bonsaidb::core::networking::List

pub struct List {
    pub database: String,
    pub collection: CollectionName,
    pub ids: Range<DocumentId>,
    pub order: Sort,
    pub limit: Option<u32>,
}

Retrieve multiple documents.

Fields

database: String

The name of the database.

collection: CollectionName

The collection of the documents.

ids: Range<DocumentId>

The range of ids to list.

order: Sort

The order for the query into the collection.

limit: Option<u32>

The maximum number of results to return.

Trait Implementations

impl Api for List

type Response = Vec<OwnedDocument, Global>

The type that represents an API response. This type will be sent to clients from the server.

type Error = Error

The error type that this can return.

fn name() -> ApiName

Returns the unique name of this api.

impl Clone for List

fn clone(&self) -> List

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for List

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for List

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

Deserialize this value from the given Serde deserializer.

impl Serialize for List

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

Serialize this value into the given Serde serializer.