Struct dodo::Repository

pub struct Repository<T, S, R> { /* fields omitted */ }

Repository of entities, backed by provided storage.

See this crate root documentation for more information.

Example

use dodo::prelude::*;

type PersonRepository = Repository<Person, Directory, JsonSerializer>;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let directory = Directory::new(&path)?;
    let mut repository = PersonRepository::new(directory);

    let mut person = Person::new();
    repository.insert(&mut person)?;

    let entities = repository.find_all()?.collect()?;

    println!("{:?}", entities);

    Ok(())
}

Methods

impl<T, S, R> Repository<T, S, R> where
    T: Entity,
    S: Storage,
    R: Serializer, 

pub fn new(storage: S) -> Self

Create a new repository, using provided storage.

Examples

use dodo::prelude::*;

type PersonRepository = Repository<Person, Directory, JsonSerializer>;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let directory = Directory::new(&path)?;
    let repository = PersonRepository::new(directory);
    Ok(())
}

pub fn find(&self, id: Uuid) -> Result<T>

Find an specific entity, if it exists.

Returns an error if not found.

Examples

let person = repository.find(id);

match person {
    Ok(person) => println!("Found!"),
    Err(dodo::Error::NotFound(_)) => println!("Not found!"),
    Err(_) => println!("Other error!")
}

pub fn find_all(&self) -> Result<RepositoryCursor<T, S, S::Iterator, R>>

Provide a cursor iterating through the entities in this repository.

Examples

let persons = repository.find_all()?.collect();

println!("{:#?}", persons);

pub fn insert(&mut self, entity: &mut T) -> Result<()>

Insert entity into this repository.

The repository always assigns a new id to the entity, even if it already has one. Thus, the entity need to be mutable when inserted.

Examples

let mut person = Person::new();  //Required to be mutable
repository.insert(&mut person)?; //Assign new id to the entity.

pub fn update(&mut self, entity: &T) -> Result<()>

Update entity in this repository to a new version.

The entity must exist in the repository and have an id.

Examples

let mut person = Person::new();
repository.insert(&mut person)?;

person.age = 1337;
repository.update(&person)?;

pub fn upsert(&mut self, entity: &T) -> Result<()>

Update or insert entity into this repository.

The entity is created if it doesn't exists, using the id currently assigned to it. You will receive an error if the entity doesn't have an id.

Examples

let mut person = Person::new();
person.id = Some(Uuid::parse_str("78190929-3d84-4735-9e40-80e3cd5530e9").unwrap());
repository.upsert(&mut person)?; //Doesn't exist ? No problem here!

let mut person = Person::new();
repository.insert(&mut person)?;
person.age = 1337;
repository.upsert(&mut person)?; //Already exist ? No problem too!

pub fn delete(&mut self, id: Uuid) -> Result<()>

Delete entity with provided id.

This does not fail if the entity doesn't exist.

Examples

let mut person = Person::new();
repository.insert(&mut person)?; //Inserted here.
repository.delete(person.id.unwrap())?; //Deleted here.

let id : Uuid = Uuid::parse_str("78190929-3d84-4735-9e40-80e3cd5530e9").unwrap();
repository.delete(id)?; //Doesn't exist ? No problem!

pub fn clear(&mut self) -> Result<()>

Delete every entity in this repository.

Everything in this repository will be deleted. Use at your own risks.

Examples

repository.insert(&mut Person::new())?;
repository.insert(&mut Person::new())?;

repository.clear();

Trait Implementations

impl<T: Clone, S: Clone, R: Clone> Clone for Repository<T, S, R>

fn clone(&self) -> Repository<T, S, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, S: Debug, R: Debug> Debug for Repository<T, S, R>

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

Formats the value using the given formatter.