Struct bonsaidb::core::test_util::BasicCollectionWithNoViews

pub struct BasicCollectionWithNoViews;

Trait Implementations

impl Collection for BasicCollectionWithNoViews

type PrimaryKey = u64

The unique id type. Each document stored in a collection will be uniquely identified by this type.

pub fn collection_name() -> CollectionName

The unique name of this collection. Each collection must be uniquely named within the Schema it is registered within.

pub fn define_views(_schema: &mut Schematic) -> Result<(), Error>

Defines all Views in this collection in schema.

fn encryption_key() -> Option<KeyId>

If a KeyId is returned, this collection will be stored encrypted at-rest using the key specified.

impl Debug for BasicCollectionWithNoViews

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

Formats the value using the given formatter.

impl SerializedCollection for BasicCollectionWithNoViews

type Contents = Basic

The type of the contents stored in documents in this collection.

type Format = Pot

The serialization format for this collection.

pub fn format() -> <BasicCollectionWithNoViews as SerializedCollection>::Format

Returns the configured instance of Self::Format.

fn natural_id(contents: &Self::Contents) -> Option<Self::PrimaryKey>

Returns the natural identifier of contents. This is called when pushing values into a collection, before attempting to automatically assign a unique id.

fn deserialize(data: &[u8]) -> Result<Self::Contents, Error>

Deserialize data as Self::Contents using this collection’s format.

fn document_contents<D>(doc: &D) -> Result<Self::Contents, Error> where
    D: Document<Self>, 

Returns the deserialized contents of doc.

fn set_document_contents<D>(
    doc: &mut D,
    contents: Self::Contents
) -> Result<(), Error> where
    D: Document<Self>, 

Sets the contents of doc to contents.

fn serialize(item: &Self::Contents) -> Result<Vec<u8, Global>, Error>

Serialize item using this collection’s format.

fn get<C, PrimaryKey>(
    id: PrimaryKey,
    connection: &C
) -> Result<Option<CollectionDocument<Self>>, Error> where
    C: Connection,
    PrimaryKey: for<'k> KeyEncoding<'k, Self::PrimaryKey>, 

Gets a CollectionDocument with id from connection.

fn get_async<'life0, 'async_trait, C, PrimaryKey>(
    id: PrimaryKey,
    connection: &'life0 C
) -> Pin<Box<dyn Future<Output = Result<Option<CollectionDocument<Self>>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    C: AsyncConnection + 'async_trait,
    PrimaryKey: for<'k> KeyEncoding<'k, Self::PrimaryKey> + 'async_trait,
    Self: 'async_trait + Send, 

Gets a CollectionDocument with id from connection.

fn get_multiple<C, DocumentIds, PrimaryKey, I>(
    ids: DocumentIds,
    connection: &C
) -> Result<Vec<CollectionDocument<Self>, Global>, Error> where
    C: Connection,
    DocumentIds: IntoIterator<Item = PrimaryKey, IntoIter = I> + Send + Sync,
    I: Iterator<Item = PrimaryKey> + Send + Sync,
    PrimaryKey: for<'k> KeyEncoding<'k, Self::PrimaryKey>, 

Retrieves all documents matching ids. Documents that are not found are not returned, but no error will be generated.

fn get_multiple_async<'life0, 'async_trait, C, DocumentIds, PrimaryKey, I>(
    ids: DocumentIds,
    connection: &'life0 C
) -> Pin<Box<dyn Future<Output = Result<Vec<CollectionDocument<Self>, Global>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    C: AsyncConnection + 'async_trait,
    DocumentIds: IntoIterator<Item = PrimaryKey, IntoIter = I> + Send + Sync + 'async_trait,
    I: Iterator<Item = PrimaryKey> + Send + Sync + 'async_trait,
    PrimaryKey: for<'k> KeyEncoding<'k, Self::PrimaryKey> + 'async_trait,
    Self: 'async_trait + Send, 

Retrieves all documents matching ids. Documents that are not found are not returned, but no error will be generated.

fn list<R, PrimaryKey, C>(
    ids: R,
    connection: &C
) -> List<'_, C, Self, PrimaryKey> where
    R: Into<Range<PrimaryKey>>,
    C: Connection,
    PrimaryKey: for<'k> KeyEncoding<'k, Self::PrimaryKey>, 

Retrieves all documents matching the range of ids.

fn list_async<R, PrimaryKey, C>(
    ids: R,
    connection: &C
) -> AsyncList<'_, C, Self, PrimaryKey> where
    R: Into<Range<PrimaryKey>>,
    C: AsyncConnection,
    PrimaryKey: for<'k> KeyEncoding<'k, Self::PrimaryKey>, 

Retrieves all documents matching the range of ids.

fn list_with_prefix<C>(
    prefix: Self::PrimaryKey,
    connection: &C
) -> List<'_, C, Self, Self::PrimaryKey> where
    C: Connection,
    Self::PrimaryKey: IntoPrefixRange, 

Retrieves all documents with ids that start with prefix.

fn list_with_prefix_async<C>(
    prefix: Self::PrimaryKey,
    connection: &C
) -> AsyncList<'_, C, Self, Self::PrimaryKey> where
    C: AsyncConnection,
    Self::PrimaryKey: IntoPrefixRange, 

Retrieves all documents with ids that start with prefix.

fn all<C>(connection: &C) -> List<'_, C, Self, Self::PrimaryKey> where
    C: Connection, 

Retrieves all documents.

fn all_async<C>(connection: &C) -> AsyncList<'_, C, Self, Self::PrimaryKey> where
    C: AsyncConnection, 

Retrieves all documents.

fn push<Cn>(
    contents: Self::Contents,
    connection: &Cn
) -> Result<CollectionDocument<Self>, InsertError<Self::Contents>> where
    Cn: Connection,
    Self: 'static, 

Pushes this value into the collection, returning the created document. This function is useful when Self != Self::Contents.

fn push_async<'life0, 'async_trait, Cn>(
    contents: Self::Contents,
    connection: &'life0 Cn
) -> Pin<Box<dyn Future<Output = Result<CollectionDocument<Self>, InsertError<Self::Contents>>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'static + 'async_trait + Send,
    Cn: 'async_trait + AsyncConnection,
    Self::Contents: 'async_trait, 

Pushes this value into the collection, returning the created document. This function is useful when Self != Self::Contents.

fn push_into<Cn>(
    self,
    connection: &Cn
) -> Result<CollectionDocument<Self>, InsertError<Self>> where
    Cn: Connection,
    Self: 'static + SerializedCollection<Contents = Self>, 

Pushes this value into the collection, returning the created document.

fn push_into_async<'life0, 'async_trait, Cn>(
    self,
    connection: &'life0 Cn
) -> Pin<Box<dyn Future<Output = Result<CollectionDocument<Self>, InsertError<Self>>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'static + SerializedCollection<Contents = Self> + 'async_trait + Send,
    Cn: 'async_trait + AsyncConnection, 

Pushes this value into the collection, returning the created document.

fn insert<PrimaryKey, Cn>(
    id: PrimaryKey,
    contents: Self::Contents,
    connection: &Cn
) -> Result<CollectionDocument<Self>, InsertError<Self::Contents>> where
    PrimaryKey: for<'k> KeyEncoding<'k, Self::PrimaryKey>,
    Cn: Connection,
    Self: 'static, 

Inserts this value into the collection with the specified id, returning the created document.

fn insert_async<'life0, 'async_trait, PrimaryKey, Cn>(
    id: PrimaryKey,
    contents: Self::Contents,
    connection: &'life0 Cn
) -> Pin<Box<dyn Future<Output = Result<CollectionDocument<Self>, InsertError<Self::Contents>>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    PrimaryKey: for<'k> KeyEncoding<'k, Self::PrimaryKey> + 'async_trait,
    Cn: AsyncConnection + 'async_trait,
    Self: 'static + 'async_trait + Send,
    Self::Contents: 'async_trait, 

Inserts this value into the collection with the specified id, returning the created document.

fn insert_into<PrimaryKey, Cn>(
    self,
    id: PrimaryKey,
    connection: &Cn
) -> Result<CollectionDocument<Self>, InsertError<Self>> where
    PrimaryKey: for<'k> KeyEncoding<'k, Self::PrimaryKey>,
    Cn: Connection,
    Self: 'static + SerializedCollection<Contents = Self>, 

Inserts this value into the collection with the given id, returning the created document.

fn insert_into_async<'life0, 'async_trait, PrimaryKey, Cn>(
    self,
    id: PrimaryKey,
    connection: &'life0 Cn
) -> Pin<Box<dyn Future<Output = Result<CollectionDocument<Self>, InsertError<Self>>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    PrimaryKey: for<'k> KeyEncoding<'k, Self::PrimaryKey> + 'async_trait,
    Cn: AsyncConnection + 'async_trait,
    Self: 'static + SerializedCollection<Contents = Self> + 'async_trait + Send, 

Inserts this value into the collection with the given id, returning the created document.

fn overwrite<PrimaryKey, Cn>(
    id: PrimaryKey,
    contents: Self::Contents,
    connection: &Cn
) -> Result<CollectionDocument<Self>, InsertError<Self::Contents>> where
    PrimaryKey: for<'k> KeyEncoding<'k, Self::PrimaryKey>,
    Cn: Connection,
    Self: 'static, 

Overwrites this value into the collection with the specified id, returning the created or updated document.

fn overwrite_async<'life0, 'async_trait, PrimaryKey, Cn>(
    id: PrimaryKey,
    contents: Self::Contents,
    connection: &'life0 Cn
) -> Pin<Box<dyn Future<Output = Result<CollectionDocument<Self>, InsertError<Self::Contents>>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    PrimaryKey: for<'k> KeyEncoding<'k, Self::PrimaryKey> + 'async_trait,
    Cn: AsyncConnection + 'async_trait,
    Self: 'static + 'async_trait + Send,
    Self::Contents: 'async_trait, 

Overwrites this value into the collection with the specified id, returning the created or updated document.

fn overwrite_into<Cn, PrimaryKey>(
    self,
    id: PrimaryKey,
    connection: &Cn
) -> Result<CollectionDocument<Self>, InsertError<Self>> where
    Cn: Connection,
    PrimaryKey: for<'k> KeyEncoding<'k, Self::PrimaryKey>,
    Self: 'static + SerializedCollection<Contents = Self>, 

Overwrites this value into the collection with the given id, returning the created or updated document.

fn overwrite_into_async<'life0, 'async_trait, Cn, PrimaryKey>(
    self,
    id: PrimaryKey,
    connection: &'life0 Cn
) -> Pin<Box<dyn Future<Output = Result<CollectionDocument<Self>, InsertError<Self>>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    PrimaryKey: for<'k> KeyEncoding<'k, Self::PrimaryKey> + 'async_trait,
    Self: 'static + SerializedCollection<Contents = Self> + 'async_trait + Send,
    Cn: 'async_trait + AsyncConnection, 

Overwrites this value into the collection with the given id, returning the created or updated document.