Struct DevShellConfig

pub struct DevShellConfig {
    pub packages: BTreeSet<String>,
    pub shell_hook: Option<String>,
    pub pure: Option<bool>,
}

@brief Represents the structure of the devshell.toml file.

Maintains a set of packages, an optional shell hook, and an optional purity flag. BTreeSet is used to keep packages sorted and unique.

Fields

packages: BTreeSet<String>

@brief Set of package names to be included in the development shell.

shell_hook: Option<String>

@brief Optional shell hook command to be executed in the shell.

pure: Option<bool>

@brief Optional flag to indicate if the shell should be pure.

Implementations

impl DevShellConfig

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

@brief Loads the configuration from CONFIG_FILE or returns a default config if not found. @return Result containing the loaded DevShellConfig or an I/O error.

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

@brief Saves the current configuration to CONFIG_FILE. @return Result indicating success or an I/O error.

pub fn append_hook(&mut self, new_hook: &str)

@brief Appends a new shell hook command to the existing shell hook.

If a shell hook already exists, the new hook is appended with a separator. If not, the new hook is set as the shell hook. @param new_hook The shell hook command to append.

Trait Implementations

impl Debug for DevShellConfig

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

Formats the value using the given formatter.

impl Default for DevShellConfig

fn default() -> DevShellConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DevShellConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DevShellConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.