thot_core/api/
interface.rs

1//! API interface functionality.
2use crate::db::resources::asset::Asset;
3use crate::db::resources::container::Container;
4use crate::db::resources::search_filter::StandardPropertiesSearchFilter as StdPropsFilter;
5use crate::result::Result;
6use std::path::PathBuf;
7
8pub trait Interface {
9    /// Returns the root of the database.
10    fn root(&self) -> PathBuf;
11
12    /// Finds a single Container matching the search fitler.
13    fn find_container(&self, search: StdPropsFilter) -> Option<Container>;
14
15    /// Finds all Containers matching the search filter.
16    fn find_containers(&self, search: StdPropsFilter) -> Vec<Container>;
17
18    /// Finds a single Asset matching the search filter.
19    fn find_asset(&self, search: StdPropsFilter) -> Option<Asset>;
20
21    /// Finds all Assets matching the search filter.
22    fn find_assets(&self, search: StdPropsFilter) -> Vec<Asset>;
23
24    /// Adds an Asset to the database.
25    fn add_asset(&mut self, asset: Asset) -> Result;
26
27    /// Returns whether the datbase is running in development mode or not.
28    fn dev_mode() -> bool;
29}
30
31#[cfg(test)]
32#[path = "./interface_test.rs"]
33mod interface_test;
thot_core/api/interface.rs

thot_core/api/
interface.rs
