Struct Storage 

pub struct Storage { /* private fields */ }

Local filesystem storage for cached llms.txt documentation

Implementations

impl Storage

pub fn flavor_from_url(url: &str) -> Flavor

Determine the appropriate flavor based on the requested URL.

pub fn new() -> Result<Self>

Creates a new storage instance with the default root directory

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

Creates a new storage instance with a custom root directory

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

Returns the directory path for a given alias

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

Ensures the directory for an alias exists and returns its path

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

Returns the path to the llms.txt file for an alias

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

Returns the path to the llms.json file for an alias

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

Compute the metadata JSON path for a given flavor.

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

Returns the path to the search index directory for an alias

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

Returns the path to the archive directory for an alias

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

Returns the path to the metadata file for an alias

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

Compute the metadata path for a given flavor.

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

Returns the path to the anchors mapping file for an alias

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

Saves the llms.txt content for an alias

pub fn save_flavor_content( &self, alias: &str, file_name: &str, content: &str, ) -> Result<()>

Saves content for a specific flavored variant (e.g., llms-full.txt)

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

Returns the path to the persisted text content for the given flavor.

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

Loads the llms.txt content for an alias

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

Saves the parsed llms.json data for the default flavor

pub fn save_flavor_json( &self, alias: &str, flavor: &str, data: &LlmsJson, ) -> Result<()>

Saves the parsed llms.json data for a specific flavor

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

Loads the parsed llms.json data for the default flavor

pub fn load_flavor_json( &self, alias: &str, flavor: &str, ) -> Result<Option<LlmsJson>>

Loads the parsed llms.json data for a specific flavor, returning None if absent

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

Saves source metadata for an alias

pub fn save_source_metadata_for_flavor( &self, alias: &str, flavor: &str, source: &Source, ) -> Result<()>

Persist source metadata for a specific flavor.

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

Save anchors remap JSON for an alias

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

Loads source metadata for an alias if it exists

pub fn load_source_metadata_for_flavor( &self, alias: &str, flavor: &str, ) -> Result<Option<Source>>

Load source metadata for a specific flavor if present.

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

Checks if an alias exists in storage

pub fn exists_any_flavor(&self, alias: &str) -> bool

Checks if any flavor has been persisted for the alias.

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

Lists all available documentation flavors persisted for a given alias.

Flavors correspond to the JSON artifacts produced during ingest, e.g. llms.json and llms-full.json. Metadata sidecars (like metadata.json) and other auxiliary files are excluded.

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

Lists all cached source aliases

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

Archives the current version of an alias