Skip to main content

RagrigConfig

Struct RagrigConfig 

Source
pub struct RagrigConfig {
    pub workspace: PathBuf,
    pub chat: ChatConfig,
    pub embed: EmbedConfig,
    pub parse: ParseConfig,
    pub memory: MemoryConfig,
    pub corpus_dirs: Vec<String>,
    pub corpus_urls: Vec<String>,
    pub semantic_scholar_api_key: Option<String>,
}
Expand description

Top-level configuration for a ragrig session.

Composes ChatConfig, EmbedConfig, ParseConfig, and MemoryConfig into a single format-agnostic tree. Serde support enables JSON/TOML profile files; the CLI binary converts clap arguments into this struct via From.

§Entry points

ⓘ
// 1. From CLI (binary only)
let config = RagrigConfig::from(Cli::parse());

// 2. From a profile file (TOML / JSON)
let config: RagrigConfig = toml::from_str(&fs::read_to_string("profile.toml")?)?;

// 3. Programmatic construction
let config = RagrigConfig {
    workspace: "./workspace".into(),
    ..Default::default()
};

Fields§

§workspace: PathBuf

Workspace directory holding the vector store (.ragrig_store), history, sessions, and profiles. Not a document corpus by itself — documents come from corpus_dirs and corpus_urls. Deserialised from "folder" in older profiles.

§chat: ChatConfig

Chat / generation settings.

§embed: EmbedConfig

Embedding / search settings.

§parse: ParseConfig

Document parsing and chunking settings.

§memory: MemoryConfig

Memory / query-rewrite settings.

§corpus_dirs: Vec<String>

Named directory corpora in name=path form (repeatable --corpus-dir). Deserialised from "source_dirs" in older profiles.

§corpus_urls: Vec<String>

Named URL corpora in name=url form (repeatable --corpus-urls; repeating a name accumulates URLs into one curated list). Deserialised from "source_urls" in older profiles.

§semantic_scholar_api_key: Option<String>

Semantic Scholar API key for higher rate limits (free). See https://www.semanticscholar.org/product/api#api-key-form for a key.

Implementations§

Source§

impl RagrigConfig

Source

pub fn from_toml(src: &str) -> Result<Self>

Parse a RagrigConfig from a TOML document (file contents or an inline string). Missing sub-tables and fields fall back to the library defaults.

Source

pub fn from_json(src: &str) -> Result<Self>

Parse a RagrigConfig from a JSON document. Missing sub-tables and fields fall back to the library defaults.

Source

pub fn override_with(&mut self, cli: &RagrigConfig)

Merge cli overrides on top of this config (typically loaded from a profile).

Fields where cli equals RagrigConfig::default() are left untouched — they were not explicitly set by the user. Only explicitly-changed fields from the CLI override the profile base.

Source

pub fn profiles_dir(folder: &Path) -> PathBuf

Directory where profile JSON files live for a given document folder.

Source

pub fn save_to_profile(&self, folder: &Path, name: &str) -> Result<(), Error>

Save this config as a named profile under folder.

Creates .ragrig/profiles/<name>.json. The workspace field of the config is not written — profiles are portable across machines; the caller’s folder argument (the workspace) is what counts and is supplied again at load time.

Source

pub fn load_from_profile(folder: &Path, name: &str) -> Result<Self, Error>

Load a named profile from .ragrig/profiles/<name>.json.

The caller’s folder (the workspace) is authoritative: a workspace value written into the file by an older version is ignored, so a profile copied from another machine can never re-point the workspace.

Source

pub fn list_profiles(folder: &Path) -> Result<Vec<String>, Error>

List all saved profile names under folder.

Trait Implementations§

Source§

impl Clone for RagrigConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RagrigConfig

Source§

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

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

impl Default for RagrigConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for RagrigConfig

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 RagrigConfig

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

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

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

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

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

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
Source§

impl<T> IntoToolOutput for T
where T: Serialize + 'static,

Source§

fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>

Convert this value without routing structured data through a string.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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