Struct Config 

pub struct Config {
    pub features: FeaturesConfig,
    pub style: StyleConfig,
}

Main configuration structure.

Contains all configuration sections for streamdown.

Fields

features: FeaturesConfig

Feature flags configuration

style: StyleConfig

Style configuration

Implementations

impl Config

pub fn default_toml() -> &'static str

Returns the default TOML configuration string.

This can be used to show users the default config or to write a default config file.

Example

use streamdown_config::Config;
let toml = Config::default_toml();
assert!(toml.contains("[features]"));
assert!(toml.contains("[style]"));

pub fn config_path() -> Option<PathBuf>

Returns the platform-specific configuration file path.

Example

use streamdown_config::Config;
if let Some(path) = Config::config_path() {
    println!("Config path: {}", path.display());
}

pub fn config_dir() -> Option<PathBuf>

Returns the platform-specific configuration directory.

pub fn ensure_config_file() -> Result<PathBuf>

Ensures the config file exists, creating it with defaults if not.

This mirrors the Python ensure_config_file function.

Returns

The path to the config file.

Example

use streamdown_config::Config;
let path = Config::ensure_config_file().unwrap();
assert!(path.exists());

pub fn load() -> Result<Self>

Load configuration from the default platform-specific path.

If no config file exists, returns the default configuration.

Example

use streamdown_config::Config;
let config = Config::load().unwrap();

pub fn load_from(path: &Path) -> Result<Self>

Load configuration from a specific path.

Arguments

• path - Path to the TOML configuration file

Example

use streamdown_config::Config;
use std::path::Path;
let config = Config::load_from(Path::new("./config.toml")).unwrap();

pub fn load_with_override(override_config: Option<&str>) -> Result<Self>

Load configuration with an optional override file or string.

This mirrors the Python ensure_config_file behavior:

1. Load the base config from the default location
2. If override_path is provided:
   • If it’s a path to an existing file, load and merge it
   • Otherwise, treat it as a TOML string and parse it

Arguments

• override_config - Optional path to override file or inline TOML string

Example

use streamdown_config::Config;

// Load with file override
let config = Config::load_with_override(Some("./custom.toml".as_ref())).unwrap();

// Load with inline TOML override
let config = Config::load_with_override(Some("[features]\nLinks = false".as_ref())).unwrap();

pub fn merge(&mut self, other: &Config)

Merge another config into this one.

Values from other take precedence over values in self. This is used for applying CLI overrides or secondary config files.

Arguments

• other - The config to merge from

Example

use streamdown_config::Config;

let mut base = Config::default();
let override_config: Config = toml::from_str(r#"
    [features]
    Links = false
"#).unwrap();

base.merge(&override_config);
assert!(!base.features.links);

pub fn save_to(&self, path: &Path) -> Result<()>

Save configuration to a file.

Arguments

• path - Path to save the configuration to

pub fn computed_style(&self) -> ComputedStyle

Compute the style values (ANSI codes) from this config.

This applies the HSV multipliers to generate actual ANSI color codes.

Example

use streamdown_config::Config;
let config = Config::default();
let computed = config.computed_style();
assert!(!computed.dark.is_empty());

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.