Skip to main content

SisterConfig

Struct SisterConfig 

Source
pub struct SisterConfig {
    pub data_path: Option<PathBuf>,
    pub data_paths: HashMap<String, PathBuf>,
    pub create_if_missing: bool,
    pub read_only: bool,
    pub memory_budget_mb: Option<usize>,
    pub options: HashMap<String, Value>,
}
Expand description

Configuration for initializing a sister.

v0.2.0: Made data paths flexible to support sisters with different storage models:

  • Memory/Vision: single data file (data_path)
  • Identity: multiple directories (data_paths)
  • Codebase: multiple graph files loaded dynamically
  • Time: single data file

Fields§

§data_path: Option<PathBuf>

Primary data file/directory path. Used by sisters with a single data location (Memory, Vision, Time)

§data_paths: HashMap<String, PathBuf>

Additional named data paths. Used by sisters with multiple data locations (Identity, Codebase).

Examples:

  • Identity: {“identities”: “/path/to/identities”, “receipts”: “/path/to/receipts”}
  • Codebase: {“default_graph”: “/path/to/graph.acb”}
§create_if_missing: bool

Whether to create if not exists

§read_only: bool

Read-only mode

§memory_budget_mb: Option<usize>

Memory budget in megabytes (optional)

§options: HashMap<String, Value>

Custom options (sister-specific)

Implementations§

Source§

impl SisterConfig

Source

pub fn new(data_path: impl Into<PathBuf>) -> Self

Create a new config with a single data path

Source

pub fn stateless() -> Self

Create a config with no data path (for stateless sisters like Time)

Source

pub fn with_paths(paths: HashMap<String, PathBuf>) -> Self

Create a config with multiple named paths (for Identity, Codebase)

Source

pub fn primary_path(&self) -> PathBuf

Get the primary data path, falling back to “.” if none set

Source

pub fn get_path(&self, name: &str) -> Option<&PathBuf>

Get a named data path

Source

pub fn add_path(self, name: impl Into<String>, path: impl Into<PathBuf>) -> Self

Add a named data path

Source

pub fn read_only(self, read_only: bool) -> Self

Set read-only mode

Source

pub fn create_if_missing(self, create: bool) -> Self

Set create if missing

Source

pub fn memory_budget(self, mb: usize) -> Self

Set memory budget

Source

pub fn option(self, key: impl Into<String>, value: impl Serialize) -> Self

Add a custom option

Source

pub fn get_option<T: for<'de> Deserialize<'de>>(&self, key: &str) -> Option<T>

Get a custom option

Trait Implementations§

Source§

impl Clone for SisterConfig

Source§

fn clone(&self) -> SisterConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SisterConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SisterConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for SisterConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for SisterConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,