couchbase_lite/
lib.rs

1//! couchbase-lite is an ergonomic wrapper for using couchbase-lite-core from Rust.
2//! ```rust
3//! # #[macro_use]
4//! # extern crate serde;
5//! # use serde::{Serialize, Deserialize};
6//! use couchbase_lite::{
7//!     Database, Document, DatabaseFlags,
8//!     fallible_streaming_iterator::FallibleStreamingIterator
9//! };
10//!
11//! #[derive(Serialize, Deserialize, Debug)]
12//! #[serde(tag = "type")]
13//! struct Message {
14//!     msg: String,
15//! }
16//!
17//! fn main() -> Result<(), couchbase_lite::Error> {
18//!     let mut db = Database::open_with_flags(
19//!         &std::env::temp_dir().join("a.cblite2"),
20//!         DatabaseFlags::CREATE,
21//!     )?;
22//!     {
23//!         let msg = Message { msg: "Test message".into() };
24//!         let mut trans = db.transaction()?;
25//!         let enc = trans.shared_encoder_session()?;
26//!         let mut doc = Document::new(&msg, enc)?;
27//!         trans.save(&mut doc)?;
28//!         trans.commit()?;
29//!     }
30//!     println!("we have {} documents in db", db.document_count());
31//!     let query = db.n1ql_query("SELECT _id FROM _default WHERE type='Message'")?;
32//!     let mut iter = query.run()?;
33//!     while let Some(item) = iter.next()? {
34//!         let id = item.get_raw_checked(0)?;
35//!         let id = id.as_str()?;
36//!         let doc = db.get_existing(id)?;
37//!         println!("doc id {}", doc.id());
38//!         let db_msg: Message = doc.decode_body()?;
39//!         println!("db_msg: {:?}", db_msg);
40//!         assert_eq!("Test message", db_msg.msg);
41//!     }
42//!     Ok(())
43//! }
44//! ```
45
46mod conflict_resolver;
47mod database;
48mod doc_enumerator;
49mod document;
50mod error;
51mod index;
52mod log_reroute;
53mod observer;
54mod query;
55mod replicator;
56mod transaction;
57mod value;
58
59pub use crate::{
60    conflict_resolver::resolve_conflict,
61    database::{Database, DatabaseConfig, DatabaseFlags},
62    doc_enumerator::{DocEnumeratorFlags, DocumentInfo},
63    document::{Document, DocumentFlags},
64    error::Error,
65    fallible_streaming_iterator::FallibleStreamingIterator,
66    index::IndexType,
67    query::Query,
68    replicator::{Replicator, ReplicatorAuthentication, ReplicatorParameters, ReplicatorState},
69    transaction::Transaction,
70    value::{ValueRef, ValueRefArray},
71};
72pub use couchbase_lite_core_sys as ffi;
73pub use fallible_streaming_iterator;
74pub use ffi::{C4CollectionSpec, C4DocumentEnded, C4QueryLanguage as QueryLanguage, C4String};
75
76pub use serde_fleece;
couchbase_lite/lib.rs

couchbase_lite/
lib.rs
