Struct dev_utils::files::toml::TomlFile

pub struct TomlFile {
    pub path: PathBuf,
    pub data: HashMap<String, HashMap<String, String>>,
}

This struct represents a *.toml file and provides methods to read and extract information from it.

Used to read and extract information from a Cargo.toml file.

Fields

path: PathBuf

data: HashMap<String, HashMap<String, String>>

Implementations

impl TomlFile

pub fn new(path: &Path) -> Self

Creates a new CargoFile instance by reading the specified Cargo.toml file.

This function initializes a CargoFile instance by reading the Cargo.toml file located at the given path. It also extracts and structures the data within the Cargo.toml file.

Arguments

• path - The path to the Cargo.toml file.

Returns

A CargoFile instance containing the Cargo.toml file path and structured data.

pub fn get_toml_data( cargo_toml_path: &Path ) -> HashMap<String, HashMap<String, String>>

Reads a Cargo.toml file, extracts information separated by sections, and returns it as a structured data.

This function parses a Cargo.toml file, extracting key-value pairs organized by sections (e.g., “package”, “dependencies”).

It also ignores comments (lines starting with #) and removes quotes from values.

Arguments

• cargo_toml_path - The path to the Cargo.toml file to be processed.

Returns

A HashMap where keys represent sections (e.g., “package”, “dependencies”) and values are sub-maps containing key-value pairs for each section. The top-level keys in the HashMap correspond to section names, and the associated sub-maps contain the key-value pairs within each section.

Example

use dev_utils::files::toml::CargoFile;
use std::collections::HashMap;
use std::path::Path;
 
let cargo_toml_path = Path::new("Cargo.toml");
let toml_data = CargoFile::get_cargo_toml_data(&cargo_toml_path);

if let Some(package_info) = toml_data.get("package") {
    if let Some(name) = package_info.get("name") {
        println!("Package name: {}", name);
    }
}

pub fn get_section_data( &self, section: &str ) -> Option<&HashMap<String, String>>

Gets the data for a specific section from the Cargo.toml file.

Arguments

• section - The name of the section to retrieve.

Returns

An Option containing a reference to the section’s data as a HashMap.

pub fn get_section_attribute( &self, section: &str, attribute: &str ) -> Option<&String>

Gets a specific attribute from a section in the Cargo.toml file.

Arguments

• section - The name of the section.
• attribute - The name of the attribute within the section.

Returns

An Option containing a reference to the attribute’s value as a String.

Trait Implementations

impl Clone for TomlFile

fn clone(&self) -> TomlFile

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TomlFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for TomlFile

fn eq(&self, other: &TomlFile) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TomlFile