Struct Learner

pub struct Learner {
    pub config: Config,
    pub database: Database,
    pub retriever: Retriever,
}

Main entry point for the library.

Coordinates database access, paper retrieval, and configuration management. Use the builder pattern to create configured instances.

Examples

// Create with defaults
let learner = Learner::new().await?;

// Or use the builder for more control
let learner = Learner::builder().with_path("config/").build().await?;

Fields

config: Config

Active configuration

database: Database

Database connection and operations

retriever: Retriever

Paper retrieval system

Implementations

impl Learner

pub fn builder() -> LearnerBuilder

Returns a builder for creating a new configured Learner instance.

This is the recommended way to construct a Learner as it provides fine-grained control over initialization options.

Examples

let learner = Learner::builder().with_path("~/.learner").build().await?;

pub async fn new() -> Result<Self>

Creates a new Learner instance with default configuration.

This will:

1. Load or create configuration at default location
2. Initialize database in default location
3. Set up default paper storage
4. Configure default retrievers

Errors

Returns error if:

• Configuration loading fails
• Directory creation fails
• Database initialization fails

Examples

let mut learner = Learner::new().await?;

// Ready to use with default configuration
let paper = learner.retriever.get_paper("2301.07041").await?;

pub async fn from_path(path: impl AsRef<Path>) -> Result<Self>

Creates a new Learner instance from a configuration file path.

Loads configuration from the specified directory, which should contain a config.toml file.

Arguments

• path - Directory containing config.toml

Errors

Returns error if:

• Configuration file does not exist
• TOML parsing fails
• Directory creation fails
• Initialization fails

Examples

// Load from custom location
let learner = Learner::from_path("~/research/papers/config").await?;

// Or use environment-specific config
let learner = Learner::from_path("/etc/learner").await?;

pub async fn with_config(config: Config) -> Result<Self>

Creates a new Learner instance with explicit configuration.

Use this when you need complete control over the configuration or are generating configuration programmatically.

Arguments

• config - Complete configuration to use

Errors

Returns error if:

• Directory creation fails
• Database initialization fails
• Retriever configuration fails

Examples

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

// Initialize with custom config
let learner = Learner::with_config(config).await?;

pub async fn init() -> Result<Self>

Initializes a new Learner instance with example configuration.

This method:

1. Creates example configuration
2. Writes example retriever configs (arXiv, DOI)
3. Sets up directory structure
4. Initializes empty database

Ideal for first-time setup or testing.

Errors

Returns error if:

• Configuration initialization fails
• Directory creation fails
• Example config writing fails
• Database initialization fails

Examples

// Initialize new installation with examples
let mut learner = Learner::init().await?;

// Ready to use with example retrievers
let paper = learner.retriever.get_paper("2301.07041").await?;

Trait Implementations

impl Clone for Learner

fn clone(&self) -> Learner

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Learner

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

Formats the value using the given formatter.