Struct ConfigManager

pub struct ConfigManager<F: FileSystem> { /* private fields */ }

Implementations

impl ConfigManager<OsFileSystem>

pub fn new() -> Result<Self, Error>

Creates a new ConfigManager with the default filesystem and config directory.

Errors

Returns an error if the home directory cannot be determined.

impl<F: FileSystem> ConfigManager<F>

pub const fn with_fs(fs: F, config_dir: PathBuf) -> Self

pub fn add_spec( &self, name: &str, file_path: &Path, force: bool, ) -> Result<(), Error>

Adds a new OpenAPI specification to the configuration from a local file.

Errors

Returns an error if:

• The spec already exists and force is false
• File I/O operations fail
• The OpenAPI spec is invalid YAML
• The spec contains unsupported features

Panics

Panics if the spec path parent directory is None (should not happen in normal usage).

pub async fn add_spec_from_url( &self, name: &str, url: &str, force: bool, ) -> Result<(), Error>

Adds a new OpenAPI specification to the configuration from a URL.

Errors

Returns an error if:

• The spec already exists and force is false
• Network requests fail
• The OpenAPI spec is invalid YAML
• The spec contains unsupported features
• Response size exceeds 10MB limit
• Request times out (30 seconds)

Panics

Panics if the spec path parent directory is None (should not happen in normal usage).

pub async fn add_spec_auto( &self, name: &str, file_or_url: &str, force: bool, ) -> Result<(), Error>

Adds a new OpenAPI specification from either a file path or URL.

This is a convenience method that automatically detects whether the input is a URL or file path and calls the appropriate method.

Errors

Returns an error if:

• The spec already exists and force is false
• File I/O operations fail (for local files)
• Network requests fail (for URLs)
• The OpenAPI spec is invalid YAML
• The spec contains unsupported features
• Response size exceeds 10MB limit (for URLs)
• Request times out (for URLs)

pub fn list_specs(&self) -> Result<Vec<String>, Error>

Lists all registered API contexts.

Errors

Returns an error if the specs directory cannot be read.

pub fn remove_spec(&self, name: &str) -> Result<(), Error>

Removes an API specification from the configuration.

Errors

Returns an error if the spec does not exist or cannot be removed.

pub fn edit_spec(&self, name: &str) -> Result<(), Error>

Opens an API specification in the default editor.

Errors

Returns an error if:

• The spec does not exist.
• The $EDITOR environment variable is not set.
• The editor command fails to execute.

pub fn load_global_config(&self) -> Result<GlobalConfig, Error>

Loads the global configuration from config.toml.

Errors

Returns an error if the configuration file exists but cannot be read or parsed.

pub fn save_global_config(&self, config: &GlobalConfig) -> Result<(), Error>

Saves the global configuration to config.toml.

Errors

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

pub fn set_url( &self, api_name: &str, url: &str, environment: Option<&str>, ) -> Result<(), Error>

Sets the base URL for an API specification.

Arguments

• api_name - The name of the API specification
• url - The base URL to set
• environment - Optional environment name for environment-specific URLs

Errors

Returns an error if the spec doesn’t exist or config cannot be saved.

pub fn get_url( &self, api_name: &str, ) -> Result<(Option<String>, HashMap<String, String>, String), Error>

Gets the base URL configuration for an API specification.

Arguments

• api_name - The name of the API specification

Returns

A tuple of (base_url_override, environment_urls, resolved_url)

Errors

Returns an error if the spec doesn’t exist.

pub fn list_urls( &self, ) -> Result<HashMap<String, (Option<String>, HashMap<String, String>)>, Error>

Lists all configured base URLs across all API specifications.

Returns

A map of API names to their URL configurations

Errors

Returns an error if the config cannot be loaded.