Struct Storage 

pub struct Storage { /* private fields */ }

Local filesystem storage for cached llms.txt documentation

Implementations

impl Storage

pub fn new() -> Result<Self>

Creates a new storage instance with the default root directory.

Errors

Returns an error if the data or config directories cannot be resolved or created.

pub fn with_root(root_dir: PathBuf) -> Result<Self>

Creates a new storage instance with a custom root directory.

Errors

Returns an error if the data or config directories cannot be created.

pub fn with_paths(root_dir: PathBuf, config_dir: PathBuf) -> Result<Self>

Creates a new storage instance with explicit data and config directories.

Errors

Returns an error if the data or config directories cannot be created.

pub fn root_dir(&self) -> &Path

Returns the root data directory path

pub fn config_dir(&self) -> &Path

Returns the root configuration directory path used for descriptors

pub fn descriptor_path(&self, alias: &str) -> Result<PathBuf>

Returns the path to the descriptor TOML for a source.

Errors

Returns an error if the alias is invalid.

pub fn save_descriptor(&self, descriptor: &SourceDescriptor) -> Result<()>

Persist a descriptor to disk, creating parent directories if necessary.

Errors

Returns an error if the descriptor cannot be serialized or written.

pub fn load_descriptor(&self, alias: &str) -> Result<Option<SourceDescriptor>>

Load a descriptor if it exists.

Errors

Returns an error if the descriptor cannot be read or parsed.

pub fn remove_descriptor(&self, alias: &str) -> Result<()>

Remove descriptor file for an alias if present.

Errors

Returns an error if the descriptor cannot be removed.

pub fn tool_dir(&self, source: &str) -> Result<PathBuf>

Returns the directory path for a given alias.

Errors

Returns an error if the alias is invalid.

pub fn ensure_tool_dir(&self, source: &str) -> Result<PathBuf>

Ensures the directory for an alias exists and returns its path.

Errors

Returns an error if the alias is invalid or the directory cannot be created.

pub fn llms_txt_path(&self, source: &str) -> Result<PathBuf>

Returns the path to the llms.txt file for a source.

Errors

Returns an error if the alias is invalid.

pub fn llms_json_path(&self, source: &str) -> Result<PathBuf>

Returns the path to the llms.json file for a source.

Errors

Returns an error if the alias is invalid.

pub fn index_dir(&self, source: &str) -> Result<PathBuf>

Returns the path to the search index directory for a source.

Errors

Returns an error if the alias is invalid.

pub fn archive_dir(&self, source: &str) -> Result<PathBuf>

Returns the path to the archive directory for a source.

Errors

Returns an error if the alias is invalid.

pub fn metadata_path(&self, source: &str) -> Result<PathBuf>

Returns the path to the metadata file for a source.

Errors

Returns an error if the alias is invalid.

pub fn anchors_map_path(&self, source: &str) -> Result<PathBuf>

Returns the path to the anchors mapping file for a source.

Errors

Returns an error if the alias is invalid.

pub fn save_llms_txt(&self, source: &str, content: &str) -> Result<()>

Saves the llms.txt content for a source.

Errors

Returns an error if the file cannot be written or renamed.

pub fn load_llms_txt(&self, source: &str) -> Result<String>

Loads the llms.txt content for a source.

Errors

Returns an error if the file cannot be read.

pub fn save_llms_json(&self, source: &str, data: &LlmsJson) -> Result<()>

Saves the parsed llms.json data for a source.

Errors

Returns an error if the JSON cannot be serialized or written.

pub fn load_llms_json(&self, source: &str) -> Result<LlmsJson>

Loads the parsed llms.json data for a source.

Errors

Returns an error if the file cannot be read or the JSON is invalid.

pub fn save_source_metadata( &self, source: &str, metadata: &Source, ) -> Result<()>

Saves source metadata for a source.

Errors

Returns an error if the metadata cannot be serialized or written.

pub fn save_anchors_map(&self, source: &str, map: &AnchorsMap) -> Result<()>

Save anchors remap JSON for a source.

Errors

Returns an error if the anchors map cannot be serialized or written.

pub fn load_source_metadata(&self, source: &str) -> Result<Option<Source>>

Loads source metadata for a source if it exists.

Errors

Returns an error if the metadata cannot be read or parsed.

pub fn exists(&self, source: &str) -> bool

Checks if a source exists in storage

pub fn list_sources(&self) -> Vec<String>

Lists all cached sources

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

Clears the entire cache directory, removing all sources and their data.

This is a destructive operation that cannot be undone. Use with caution.

Errors

Returns an error if the cache directory cannot be removed or recreated.

pub fn archive(&self, source: &str) -> Result<()>

Archives the current version of a source.

Errors

Returns an error if the archive directory cannot be created or files cannot be copied.

Trait Implementations

impl RefreshStorage for Storage

fn load_metadata(&self, alias: &str) -> Result<Source>

Load stored metadata for a source alias.

fn load_llms_aliases(&self, alias: &str) -> Result<Vec<String>>

Load alias list from the cached llms.json for a source.

fn save_llms_txt(&self, alias: &str, content: &str) -> Result<()>

Persist the latest llms.txt content.

fn save_llms_json(&self, alias: &str, data: &LlmsJson) -> Result<()>

Persist the computed llms.json metadata payload.

fn save_metadata(&self, alias: &str, metadata: &Source) -> Result<()>

Persist updated source metadata.

fn index_path(&self, alias: &str) -> Result<PathBuf>

Resolve the on-disk index path for a source.

fn load_llms_txt(&self, alias: &str) -> Result<String>

Load cached llms.txt content for a source.