Struct dittolive_ditto::store::collection::Collection

pub struct Collection { /* fields omitted */ }

Implementations

impl Collection

pub fn name(&self) -> &str

pub fn find_all(&self) -> PendingCursorOperation<'_>

Generates a DittoPendingCursorOperation that can be used to find all documents in the collection at a point in time or you can chain a call to observe, observeLocal, or subscribe if you want to get updates about documents in the collection over time. It can also be used to update, remove or evict documents.

pub fn find(&self, query: &str) -> PendingCursorOperation<'_>

Generates a DittoPendingCursorOperation with the provided query that can be used to find the documents matching the query at a point in time or you can chain a call to observe, observeLocal, or subscribe if you want to get updates about documents matching the query as they occur. It can also be used to update, remove, or evict documents.

pub fn find_with_args<V: Serialize>(
    &self,
    query: &str,
    query_args: impl Borrow<V>
) -> PendingCursorOperation<'_>

Generates a DittoPendingCursorOperation with the provided query and query arguments that can be used to find the documents matching the query at a point in time or you can chain a call to observe, observeLocal, or subscribe if you want to get updates about documents matching the query as they occur. It can also be used to update, remove, or evict documents.

This is the recommended function to use when performing queries on a collection if you have any dynamic data included in the query string. It allows you to provide a query string with placeholders, in the form of $args.my_arg_name, along with an accompanying dictionary of arguments, in the form of { "my_arg_name": "some value" }, and the placeholders will be appropriately replaced by the matching provided arguments from the dictionary. This includes handling things like wrapping strings in quotation marks and arrays in square brackets, for example.

pub fn find_by_id(&self, doc_id: DocumentId) -> PendingIdSpecificOperation

Generates a DittoPendingIDSpecificOperation with the provided document ID that can be used to find the document at a point in time or you can chain a call to observe, observeLocal, or subscribe if you want to get updates about the document over time. It can also be used to update, remove or evict the document.

impl Collection

pub fn insert<V: Serialize>(
    &self,
    content: impl Borrow<V>,
    id: Option<&DocumentId>,
    is_default: bool
) -> Result<DocumentId, DittoError>

Inserts a new document into the collection and returns its assigned ID. A DocumentId may be provided or if None, a document ID will be auto-generated

pub fn insert_with_strategy<V: Serialize>(
    &self,
    content: impl Borrow<V>,
    id: Option<&DocumentId>,
    write_strategy: WriteStrategy
) -> Result<DocumentId, DittoError>

Inserts a new document into the collection and returns its assigned ID. A DocumentId may be provided or if None, a document ID will be auto-generated

pub fn new_attachment<P: AsRef<Path>>(
    &self,
    path: P,
    metadata: HashMap<String, String>
) -> Result<DittoAttachment, DittoError>

Creates a new attachment, which can then be inserted into a document.

The file residing at the provided path will be copied into the Ditto’s store. The DittoAttachment object that is returned is what you can then use to insert an attachment into a document.

You can provide metadata about the attachment, which will be replicated to other peers alongside the file attachment.

Below is a snippet to show how you can use the new_attachment functionality to insert an attachment into a document.

pub fn fetch_attachment<'a>(
    &self,
    attachment_token: DittoAttachmentToken,
    on_fetch_event: impl Fn(DittoAttachmentFetchEvent) + Send + Sync + 'a
) -> Result<DittoAttachmentFetcher<'a>, DittoError>

Fetch the attachment corresponding to the provided attachment token.

• onchange - A closure that will be called when the status of the request to fetch the attachment has changed. If the attachment is already available then this will be called almost immediately with a completed status value.

Trait Implementations

impl Clone for Collection

fn clone(&self) -> Collection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Collection

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

Formats the value using the given formatter.