Struct ConfigFile 

pub struct ConfigFile { /* private fields */ }

This struct holds the configuration data to use the Jira API (authentication info and Jira base_url).

Implementations

impl ConfigFile

Implementation of ConfigFile

Methods

• new(auth_token: String, jira_url: String) -> ConfigFile - creates a new instance of ConfigFile
• default() -> ConfigFile - creates a new instance of ConfigFile with default values
• write_to_file(file: &str) -> Result<(), std::io::Error> - writes the ConfigFile to a file
• read_from_file(file: &str) -> Result<ConfigFile, std::io::Error> - reads the ConfigFile from a file
• get_auth() -> AuthSection - gets the AuthSection from the ConfigFile
• get_jira() -> JiraSection - gets the JiraSection from the ConfigFile
• set_auth(auth: AuthSection) - sets the AuthSection in the ConfigFile
• set_jira(jira: JiraSection) - sets the JiraSection in the ConfigFile
• set_standard_resolution(standard_resolution: String) - sets the standard_resolution in the ConfigFile
• get_standard_resolution() -> String - gets the standard_resolution from the ConfigFile
• set_standard_resolution_comment(standard_resolution_comment: String) - sets the standard_resolution_comment in the ConfigFile
• get_standard_resolution_comment() -> String - gets the standard_resolution_comment from the Config
• add_transition_name(key: String, value: String) - adds a transition_name to the ConfigFile
• get_transition_name(key: &str) -> Option<String> - gets a transition_name from the ConfigFile

pub fn new( auth_token: String, jira_url: String, standard_resolution: String, standard_resolution_comment: String, transitions_names: Table, yara: YaraSection, ) -> ConfigFile

Create a new ConfigFile struct.

Arguments

• auth_token - The authentication token to be used with the Jira API.
• jira_url - The base_url for the Jira API.
• standard_resolution - The standard resolution to be used when resolving an issue.
• standard_resolution_comment - The standard comment to be used when resolving an issue.
• transitions_names - The transitions names to be used when transitioning an issue.
• yara - The YARA scanner configuration section.

Returns

• A new ConfigFile struct.

Examples

use jirust_cli::config::config_file::{ConfigFile, YaraSection};
use toml::Table;

let config = ConfigFile::new("auth_token".to_string(), "jira_url".to_string(), "standard_resolution".to_string(), "standard_resolution_comment".to_string(), Table::new(), YaraSection::default());

assert_eq!(config.get_auth_key(), "auth_token");
assert_eq!(config.get_jira_url(), "jira_url");
assert_eq!(config.get_standard_resolution(), "standard_resolution");
assert_eq!(config.get_standard_resolution_comment(), "standard_resolution_comment");

pub fn set_auth_key(&mut self, auth_token: String)

Set the authentication token for the ConfigFile struct. This is the token that will be used to authenticate with the Jira API.

Arguments

• auth_token - The authentication token to be used with the Jira API.

Examples

use jirust_cli::config::config_file::ConfigFile;

let mut config = ConfigFile::default();
config.set_auth_key("auth_key".to_string());

assert_eq!(config.get_auth_key(), "auth_key");

pub fn get_auth_key(&self) -> &str

Get the authentication token for the ConfigFile struct. This is the token that will be used to authenticate with the Jira API. This is useful for getting the current value of the authentication token.

Returns

• The authentication token to be used with the Jira API.

Examples

use jirust_cli::config::config_file::{ConfigFile, YaraSection};
use toml::Table;

let config = ConfigFile::new("auth_token".to_string(), "jira_url".to_string(), "standard_resolution".to_string(), "standard_resolution_comment".to_string(), Table::new(), YaraSection::default());
let auth_key = config.get_auth_key();

assert_eq!(auth_key, "auth_token");

pub fn set_jira_url(&mut self, jira_url: String)

Set the Jira URL for the ConfigFile struct. This is the base URL for the Jira API.

Arguments

• jira_url - The base URL for the Jira API.

Examples

use jirust_cli::config::config_file::ConfigFile;

let mut config = ConfigFile::default();
config.set_jira_url("jira_url".to_string());

assert_eq!(config.get_jira_url(), "jira_url");

pub fn get_jira_url(&self) -> &str

Get the Jira URL for the ConfigFile struct. This is the base URL for the Jira API.

Returns

• The base URL for the Jira API.

Examples

use jirust_cli::config::config_file::{ConfigFile, YaraSection};
use toml::Table;

let config = ConfigFile::new("auth_token".to_string(), "jira_url".to_string(), "standard_resolution".to_string(), "standard_resolution_comment".to_string(), Table::new(), YaraSection::default());
let jira_url = config.get_jira_url();

assert_eq!(jira_url, "jira_url");

pub fn set_standard_resolution(&mut self, standard_resolution: String)

Set the standard resolution for the ConfigFile struct. This is the standard resolution that will be used when resolving an issue.

Arguments

• standard_resolution - The standard resolution to be used when resolving an issue.

Examples

use jirust_cli::config::config_file::ConfigFile;

let mut config = ConfigFile::default();
config.set_standard_resolution("standard_resolution".to_string());

assert_eq!(config.get_standard_resolution(), "standard_resolution");

pub fn get_standard_resolution(&self) -> &String

Get the standard resolution for the ConfigFile struct. This is the standard resolution that will be used when resolving an issue.

Returns

• The standard resolution to be used when resolving an issue.

Examples

use jirust_cli::config::config_file::{ConfigFile, YaraSection};
use toml::Table;

let config = ConfigFile::new("auth_token".to_string(), "jira_url".to_string(), "standard_resolution".to_string(), "standard_resolution_comment".to_string(), Table::new(), YaraSection::default());
let standard_resolution = config.get_standard_resolution();

assert_eq!(config.get_standard_resolution(), "standard_resolution");

pub fn set_standard_resolution_comment( &mut self, standard_resolution_comment: String, )

Set the standard resolution comment for the ConfigFile struct. This is the standard resolution comment that will be used when resolving an issue.

Arguments

• standard_resolution_comment - The standard resolution comment to be used when resolving an issue.

Examples

use jirust_cli::config::config_file::ConfigFile;

let mut config = ConfigFile::default();
config.set_standard_resolution_comment("standard_resolution_comment".to_string());

assert_eq!(config.get_standard_resolution_comment(), "standard_resolution_comment");

pub fn get_standard_resolution_comment(&self) -> &String

Get the standard resolution comment for the ConfigFile struct. This is the standard resolution comment that will be used when resolving an issue.

Returns

• The standard resolution comment to be used when resolving an issue.

Examples

use jirust_cli::config::config_file::{ConfigFile, YaraSection};
use toml::Table;

let config = ConfigFile::new("auth_token".to_string(), "jira_url".to_string(), "standard_resolution".to_string(), "standard_resolution_comment".to_string(), Table::new(), YaraSection::default());
let standard_resolution_comment = config.get_standard_resolution_comment();

assert_eq!(standard_resolution_comment, "standard_resolution_comment");

pub fn add_transition_name(&mut self, key: String, value: String)

Add a transition name to the ConfigFile struct. This is used to store the transition name for a specific transition. This is used to transition an issue to a specific state. The key is the transition internal identifier and the value is the transition name.

Arguments

• key - The transition internal identifier.
• value - The transition name.

Examples

use jirust_cli::config::config_file::ConfigFile;

let mut config = ConfigFile::default();
config.add_transition_name("transition_key".to_string(), "Transition name".to_string());

assert_eq!(config.get_transition_name("transition_key"), Some(vec!["Transition name".to_string()]));

pub fn get_transition_name(&self, key: &str) -> Option<Vec<String>>

Get the transition name for a specific transition internal identifier. This is used to transition an issue to a specific state. The key is the transition internal identifier and the value is the transition name. If the transition internal identifier does not exist, None is returned.

Arguments

• key - The transition internal identifier.

Returns

• The transition name for the specific transition internal identifier.

Examples

use jirust_cli::config::config_file::ConfigFile;

let mut config = ConfigFile::default();
config.add_transition_name("transition_key".to_string(), "Transition name".to_string());

assert_eq!(config.get_transition_name("transition_key"), Some(vec!["Transition name".to_string()]));

pub fn get_yara_section(&self) -> &YaraSection

Get the YARA section from the ConfigFile struct.

Returns

• The YARA section from the ConfigFile.

pub fn get_yara_rules_source(&self) -> &str

Get the YARA rules source URL from the ConfigFile struct.

Returns

• The YARA rules source URL.

pub fn get_yara_rules_directory(&self) -> &str

Get the YARA rules directory from the ConfigFile struct.

Returns

• The YARA rules directory name (relative to ~/.jirust-cli/).

pub fn get_yara_cache_file(&self) -> &str

Get the YARA cache file from the ConfigFile struct.

Returns

• The YARA cache file name (relative to ~/.jirust-cli/).

pub fn get_yara_cache_version_file(&self) -> &str

Get the YARA cache version file from the ConfigFile struct.

Returns

• The YARA cache version file name (relative to ~/.jirust-cli/).

pub fn set_yara_rules_source(&mut self, source: String)

Set the YARA rules source URL for the ConfigFile struct.

Arguments

• source - The YARA rules source URL (git repo or zip file).

pub fn set_yara_rules_directory(&mut self, directory: String)

Set the YARA rules directory for the ConfigFile struct.

Arguments

• directory - The YARA rules directory name (relative to ~/.jirust-cli/).

pub fn set_yara_cache_file(&mut self, file: String)

Set the YARA cache file for the ConfigFile struct.

Arguments

• file - The YARA cache file name (relative to ~/.jirust-cli/).

pub fn set_yara_cache_version_file(&mut self, file: String)

Set the YARA cache version file for the ConfigFile struct.

Arguments

• file - The YARA cache version file name (relative to ~/.jirust-cli/).

pub fn write_to_file(&self, file_path: &str) -> Result<(), Error>

Stores the configuration to a file. This will overwrite the file if it already exists.

Arguments

• file_path - The path to the file to write the configuration to.

Returns

• A Result containing either an empty Ok or an error.

Examples

use jirust_cli::config::config_file::{ConfigFile, YaraSection};
use toml::Table;

let config = ConfigFile::new("auth_token".to_string(), "jira_url".to_string(), "standard_resolution".to_string(), "standard_resolution_comment".to_string(), Table::new(), YaraSection::default());
let result = config.write_to_file("config.toml");

assert!(result.is_ok());

pub fn read_from_file(file_path: &str) -> Result<ConfigFile, Error>

Loads the configuration from a file. If the file does not exist, it will return a ConfigFile with default values. If the file is not valid toml, it will return an error. If the file is valid toml, it will return the ConfigFile.

Arguments

• file_path - The path to the file to read the configuration from.

Returns

• A Result containing either the ConfigFile or an error.

Examples

use jirust_cli::config::config_file::ConfigFile;
use std::path::Path;

// Try both possible paths to handle different working directories
let config_path = if Path::new("config_example.toml").exists() {
    "config_example.toml"
} else {
    "jirust-cli/config_example.toml"
};

let config = ConfigFile::read_from_file(config_path);

assert!(config.clone().is_ok());
assert_eq!(config.clone().unwrap().get_auth_key(), "auth_key");
assert_eq!(config.clone().unwrap().get_jira_url(), "jira_url");

Trait Implementations

impl Clone for ConfigFile

fn clone(&self) -> ConfigFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigFile

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

Formats the value using the given formatter.

impl Default for ConfigFile

fn default() -> ConfigFile

Create a new ConfigFile struct with default values. This is useful for creating a new configuration file. The default values can be set using the set methods. The default values are:

• auth_token: “”
• jira_url: “”
• standard_resolution: “”
• standard_resolution_comment: “”
• transitions_names: Table::new()
• yara: YaraSection::default()

Returns

• A new ConfigFile struct with default values.

Examples

use jirust_cli::config::config_file::ConfigFile;
use toml::Table;

let config = ConfigFile::default();

assert_eq!(config.get_auth_key(), "");
assert_eq!(config.get_jira_url(), "");
assert_eq!(config.get_standard_resolution(), "");
assert_eq!(config.get_standard_resolution_comment(), "");

impl<'de> Deserialize<'de> for ConfigFile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ConfigFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.