Struct exar::Connection

pub struct Connection { /* fields omitted */ }

Exar DB's database connection, which contains a reference to a collection wrapped into an Arc/Mutex. It allows publishing and subscribing to the underling collection of events.

Examples

extern crate exar;

use exar::*;
use std::sync::{Arc, Mutex};

let collection_name = "test";
let collection_config = CollectionConfig::default();
let collection = Collection::new(collection_name, &collection_config).unwrap();
let connection = Connection::new(Arc::new(Mutex::new(collection)));

Methods

impl Connection

fn new(collection: Arc<Mutex<Collection>>) -> Connection

Creates a new instance of a connection with the given collection.

fn publish(&self, event: Event) -> Result<u64, DatabaseError>

Publishes an event into the underlying collection and returns the id for the event created or a DatabaseError if a failure occurs.

fn subscribe(&self, query: Query) -> Result<EventStream, DatabaseError>

Subscribes to the underlying collection of events using the given query and returns an event stream or a DatabaseError if a failure occurs.

fn close(self)

Closes the connection.

Trait Implementations

impl Clone for Connection

fn clone(&self) -> Connection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Connection

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.