Struct Config 

pub struct Config {
    pub database_path: PathBuf,
    pub storage_path: PathBuf,
    pub retrievers_path: PathBuf,
}

Core configuration for the library.

Manages paths for database, document storage, and retriever configurations. The configuration can be loaded from disk or created programmatically.

Examples

// Load existing config
let config = Config::load()?;

// Or create custom config
let config = Config::default()
  .with_database_path(&PathBuf::from("papers.db"))
  .with_storage_path(&PathBuf::from("papers"));

Fields

database_path: PathBuf

The path to store the database.

storage_path: PathBuf

The path to store associated documents and files.

retrievers_path: PathBuf

The path to load retriever configs from.

Implementations

impl Config

pub fn default_path() -> Result<PathBuf>

Returns the default configuration directory path, creating it if needed.

The default location is:

• Unix: ~/.learner
• Windows: %USERPROFILE%\.learner

Errors

Returns error if:

• Home directory cannot be determined
• Directory creation fails
• Insufficient permissions

pub fn default_retrievers_path() -> PathBuf

Returns the default path for retriever configuration files.

The path is constructed as {config_dir}/retrievers where config_dir is determined by default_path().

pub fn load() -> Result<Self>

Loads existing configuration or creates new with defaults.

Looks for configuration file at the default path. If not found, creates new configuration file with default settings.

Errors

Returns error if:

• Configuration file exists but cannot be read
• TOML parsing fails
• File creation fails when saving defaults

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

Saves current configuration to disk.

Writes configuration to the default path in TOML format and ensures all required directories exist.

Errors

Returns error if:

• TOML serialization fails
• File write fails
• Directory creation fails

pub fn init() -> Result<Self>

Creates new configuration with example retriever configurations.

Initializes configuration with defaults and creates example configurations for arXiv and DOI retrievers.

Errors

Returns error if:

• Configuration save fails
• Retriever directory creation fails
• Example config writes fail

pub fn with_database_path(self, database_path: &Path) -> Self

Sets the database file path.

Arguments

• database_path - Path where the SQLite database file should be stored

Examples

let config = Config::default().with_database_path(&PathBuf::from("~/papers/db.sqlite"));

pub fn with_retrievers_path(self, retrievers_path: &Path) -> Self

Sets the path for retriever configuration files.

Arguments

• retrievers_path - Directory where retriever TOML configs are stored

pub fn with_storage_path(self, storage_path: &Path) -> Self

Sets the path for paper document storage.

Arguments

• storage_path - Directory where paper PDFs will be stored

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.