Struct BuiltinConfig 

pub struct BuiltinConfig;

Built-in configuration file embedder/extractor.

Embeds the files under /examples/ into the binary.

Implementations

impl BuiltinConfig

pub fn compressed(file_path: &str) -> Option<EmbeddedCompressedFile>

pub fn get(file_path: &str) -> Option<EmbeddedFile>

pub fn iter() -> impl Iterator<Item = Cow<'static, str>> + 'static

Iterates over the file paths in the folder.

impl BuiltinConfig

pub fn get_config(name: String) -> Result<String>

Extracts the embedded content.

pub fn parse(name: String) -> Result<(Config, String)>

Parses the extracted content into Config along with the name.

pub fn validate_templates_dir(dir: &Path) -> Result<()>

Validates a user-defined templates directory.

pub fn get_config_from( name: String, templates_dir: Option<&Path>, ) -> Result<String>

Extracts the template content for name, preferring a user-provided template found in templates_dir (if given) over the built-in template of the same name. The .toml extension is optional in name.

pub fn list() -> Vec<String>

Lists the names of the built-in templates, without the .toml extension and in sorted order.

pub fn list_templates(templates_dir: Option<&Path>) -> Result<Vec<String>>

Lists the names of every available template — built-in templates plus the .toml templates found in templates_dir (if given) — without the .toml extension, sorted and deduplicated.

Returns an error if templates_dir is provided but cannot be read (e.g. it does not exist or is not a directory).

Trait Implementations

impl RustEmbed for BuiltinConfig

fn compressed(file_path: &str) -> Option<EmbeddedCompressedFile>

Available on crate feature compression only.

Get file compressed

fn get(file_path: &str) -> Option<EmbeddedFile>

Get an embedded file and its metadata.

fn iter() -> Filenames

Iterates over the file paths in the folder.