1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
use std::fmt::Debug;
use arc_bytes::serde::{Bytes, CowBytes};
use crate::{
connection::{AsyncConnection, Connection},
document::{BorrowedDocument, CollectionHeader, DocumentId, Header, OwnedDocument},
schema::SerializedCollection,
Error,
};
/// A document with serializable contents.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct CollectionDocument<C>
where
C: SerializedCollection,
{
/// The header of the document, which contains the id and `Revision`.
pub header: CollectionHeader<C::PrimaryKey>,
/// The document's contents.
pub contents: C::Contents,
}
impl<'a, C> TryFrom<&'a BorrowedDocument<'a>> for CollectionDocument<C>
where
C: SerializedCollection,
{
type Error = Error;
fn try_from(value: &'a BorrowedDocument<'a>) -> Result<Self, Self::Error> {
Ok(Self {
contents: C::deserialize(&value.contents)?,
header: CollectionHeader::try_from(value.header.clone())?,
})
}
}
impl<'a, C> TryFrom<&'a OwnedDocument> for CollectionDocument<C>
where
C: SerializedCollection,
{
type Error = Error;
fn try_from(value: &'a OwnedDocument) -> Result<Self, Self::Error> {
Ok(Self {
contents: C::deserialize(&value.contents)?,
header: CollectionHeader::try_from(value.header.clone())?,
})
}
}
impl<'a, 'b, C> TryFrom<&'b CollectionDocument<C>> for BorrowedDocument<'a>
where
C: SerializedCollection,
{
type Error = crate::Error;
fn try_from(value: &'b CollectionDocument<C>) -> Result<Self, Self::Error> {
Ok(Self {
contents: CowBytes::from(C::serialize(&value.contents)?),
header: Header::try_from(value.header.clone())?,
})
}
}
impl<C> CollectionDocument<C>
where
C: SerializedCollection,
{
/// Stores the new value of `contents` in the document.
///
/// ```rust
/// # bonsaidb_core::__doctest_prelude!();
/// # use bonsaidb_core::connection::Connection;
/// # fn test_fn<C: Connection>(db: C) -> Result<(), Error> {
/// if let Some(mut document) = MyCollection::get(42, &db)? {
/// // modify the document
/// document.update(&db)?;
/// println!("Updated revision: {:?}", document.header.revision);
/// }
/// # Ok(())
/// # }
/// ```
pub fn update<Cn: Connection>(&mut self, connection: &Cn) -> Result<(), Error> {
let mut doc = self.to_document()?;
connection.update::<C, _>(&mut doc)?;
self.header = CollectionHeader::try_from(doc.header)?;
Ok(())
}
/// Stores the new value of `contents` in the document.
///
/// ```rust
/// # bonsaidb_core::__doctest_prelude!();
/// # use bonsaidb_core::connection::AsyncConnection;
/// # fn test_fn<C: AsyncConnection>(db: C) -> Result<(), Error> {
/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
/// if let Some(mut document) = MyCollection::get_async(42, &db).await? {
/// // modify the document
/// document.update_async(&db).await?;
/// println!("Updated revision: {:?}", document.header.revision);
/// }
/// # Ok(())
/// # })
/// # }
/// ```
pub async fn update_async<Cn: AsyncConnection>(
&mut self,
connection: &Cn,
) -> Result<(), Error> {
let mut doc = self.to_document()?;
connection.update::<C, _>(&mut doc).await?;
self.header = CollectionHeader::try_from(doc.header)?;
Ok(())
}
/// Modifies `self`, automatically retrying the modification if the document
/// has been updated on the server.
///
/// ## Data loss warning
///
/// If you've modified `self` before calling this function and a conflict
/// occurs, all changes to self will be lost when the current document is
/// fetched before retrying the process again. When you use this function,
/// you should limit the edits to the value to within the `modifier`
/// callback.
pub fn modify<Cn: Connection, Modifier: FnMut(&mut Self) + Send + Sync>(
&mut self,
connection: &Cn,
mut modifier: Modifier,
) -> Result<(), Error>
where
C::Contents: Clone,
{
let mut is_first_loop = true;
// TODO this should have a retry-limit.
loop {
// On the first attempt, we want to try sending the update to the
// database without fetching new contents. If we receive a conflict,
// on future iterations we will first re-load the data.
if is_first_loop {
is_first_loop = false;
} else {
*self =
C::get(self.header.id.clone(), connection)?.ok_or_else(
|| match DocumentId::new(self.header.id.clone()) {
Ok(id) => Error::DocumentNotFound(C::collection_name(), Box::new(id)),
Err(err) => err,
},
)?;
}
modifier(&mut *self);
match self.update(connection) {
Err(Error::DocumentConflict(..)) => {}
other => return other,
}
}
}
/// Modifies `self`, automatically retrying the modification if the document
/// has been updated on the server.
///
/// ## Data loss warning
///
/// If you've modified `self` before calling this function and a conflict
/// occurs, all changes to self will be lost when the current document is
/// fetched before retrying the process again. When you use this function,
/// you should limit the edits to the value to within the `modifier`
/// callback.
pub async fn modify_async<Cn: AsyncConnection, Modifier: FnMut(&mut Self) + Send + Sync>(
&mut self,
connection: &Cn,
mut modifier: Modifier,
) -> Result<(), Error>
where
C::Contents: Clone,
{
let mut is_first_loop = true;
// TODO this should have a retry-limit.
loop {
// On the first attempt, we want to try sending the update to the
// database without fetching new contents. If we receive a conflict,
// on future iterations we will first re-load the data.
if is_first_loop {
is_first_loop = false;
} else {
*self = C::get_async(self.header.id.clone(), connection)
.await?
.ok_or_else(|| match DocumentId::new(self.header.id.clone()) {
Ok(id) => Error::DocumentNotFound(C::collection_name(), Box::new(id)),
Err(err) => err,
})?;
}
modifier(&mut *self);
match self.update_async(connection).await {
Err(Error::DocumentConflict(..)) => {}
other => return other,
}
}
}
/// Removes the document from the collection.
///
/// ```rust
/// # bonsaidb_core::__doctest_prelude!();
/// # use bonsaidb_core::connection::Connection;
/// # fn test_fn<C: Connection>(db: C) -> Result<(), Error> {
/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
/// if let Some(document) = MyCollection::get(42, &db)? {
/// document.delete(&db)?;
/// }
/// # Ok(())
/// # })
/// # }
/// ```
pub fn delete<Cn: Connection>(&self, connection: &Cn) -> Result<(), Error> {
connection.collection::<C>().delete(self)?;
Ok(())
}
/// Removes the document from the collection.
///
/// ```rust
/// # bonsaidb_core::__doctest_prelude!();
/// # use bonsaidb_core::connection::AsyncConnection;
/// # fn test_fn<C: AsyncConnection>(db: C) -> Result<(), Error> {
/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
/// if let Some(document) = MyCollection::get_async(42, &db).await? {
/// document.delete_async(&db).await?;
/// }
/// # Ok(())
/// # })
/// # }
/// ```
pub async fn delete_async<Cn: AsyncConnection>(&self, connection: &Cn) -> Result<(), Error> {
connection.collection::<C>().delete(self).await?;
Ok(())
}
/// Converts this value to a serialized `Document`.
pub fn to_document(&self) -> Result<OwnedDocument, Error> {
Ok(OwnedDocument {
contents: Bytes::from(C::serialize(&self.contents)?),
header: Header::try_from(self.header.clone())?,
})
}
}
/// Helper functions for a slice of [`OwnedDocument`]s.
pub trait OwnedDocuments {
/// Returns a list of deserialized documents.
fn collection_documents<C: SerializedCollection>(
&self,
) -> Result<Vec<CollectionDocument<C>>, Error>;
}
impl OwnedDocuments for [OwnedDocument] {
fn collection_documents<C: SerializedCollection>(
&self,
) -> Result<Vec<CollectionDocument<C>>, Error> {
self.iter().map(CollectionDocument::try_from).collect()
}
}