Skip to main content

PathManager

Struct PathManager 

Source
pub struct PathManager {
    base_dir: PathBuf,
    subcog_dir: PathBuf,
}
Expand description

Manages storage paths for subcog backends.

PathManager provides a centralized way to construct paths for:

  • SQLite index databases
  • Vector similarity indices
  • The user-level data directory

Project scope uses the user-level data directory with project facets.

Fields§

§base_dir: PathBuf

Base directory for storage (user data dir).

§subcog_dir: PathBuf

The subcog data directory (same as base dir).

Implementations§

Source§

impl PathManager

Source

pub fn for_repo(_repo_root: impl AsRef<Path>) -> Self

Creates a PathManager for repository-scoped storage.

Storage paths will be within the user data directory. Falls back to a temporary user-level directory if the user data dir cannot be resolved.

§Arguments
  • repo_root - Path to the git repository root
§Examples
let manager = PathManager::for_repo(Path::new("/home/user/project"));
// Uses user data directory, not repo-local storage
Source

pub fn for_user(user_data_dir: impl AsRef<Path>) -> Self

Creates a PathManager for user-scoped storage.

Storage paths will be directly within the user data directory (no .subcog subdirectory).

§Arguments
  • user_data_dir - Platform-specific user data directory
§Examples
let manager = PathManager::for_user(Path::new("/home/user/.local/share/subcog"));
assert_eq!(manager.subcog_dir(), Path::new("/home/user/.local/share/subcog"));
Source

pub fn base_dir(&self) -> &Path

Returns the base directory (user data dir).

Source

pub fn subcog_dir(&self) -> &Path

Returns the subcog data directory.

For project/user scope: {user_data_dir} (same as base)

Source

pub fn index_path(&self) -> PathBuf

Returns the path to the SQLite index database.

§Returns

{subcog_dir}/index.db

Source

pub fn vector_path(&self) -> PathBuf

Returns the path to the vector similarity index.

§Returns

{subcog_dir}/vectors.idx

Source

pub fn graph_path(&self) -> PathBuf

Returns the path to the graph SQLite database.

§Returns

{subcog_dir}/graph.db

Source

pub fn ensure_subcog_dir(&self) -> Result<()>

Ensures the subcog directory exists.

Creates the directory and any necessary parent directories.

§Errors

Returns an error if directory creation fails due to permissions or other filesystem issues.

§Examples
let manager = PathManager::for_repo(Path::new("/path/to/repo"));
manager.ensure_subcog_dir()?;
// Now safe to create backends at manager.index_path() and manager.vector_path()
Source

pub fn ensure_parent_dir(path: &Path) -> Result<()>

Ensures the parent directory of a path exists.

Useful for ensuring index or vector file parents exist before creating backends.

§Arguments
  • path - The path whose parent should be created
§Errors

Returns an error if directory creation fails.

Trait Implementations§

Source§

impl Clone for PathManager

Source§

fn clone(&self) -> PathManager

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 PathManager

Source§

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

Formats the value using the given formatter. 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> DynClone for T
where T: Clone,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,