Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub si: Option<SiConfig>,
    pub gitlab: Option<GitLabConfig>,
    pub jira: Option<JiraConfig>,
    pub monitor: Option<MonitorConfig>,
    pub server: Option<ServerConfig>,
    pub kasl_server: Option<KaslServerConfig>,
    pub productivity: Option<ProductivityConfig>,
    pub report: Option<ReportConfig>,
    pub task_discovery: Option<TaskDiscoveryConfig>,
    pub jira_inbox: Option<JiraInboxConfig>,
}
Expand description

The root configuration. Every module is optional, and unset modules are omitted from the JSON, so the file only names what is configured.

Fields§

§si: Option<SiConfig>

SiServer integration.

§gitlab: Option<GitLabConfig>

GitLab integration (commit discovery).

§jira: Option<JiraConfig>

Jira integration (issue discovery, inbox).

§monitor: Option<MonitorConfig>

Activity monitor settings.

§server: Option<ServerConfig>

SiServer, the third-party corporate reporting API.

§kasl_server: Option<KaslServerConfig>

kasl-server: the team server this agent reports to.

§productivity: Option<ProductivityConfig>

Productivity thresholds.

§report: Option<ReportConfig>

Report export defaults.

§task_discovery: Option<TaskDiscoveryConfig>

Task discovery ignore list; built-in defaults apply when absent.

§jira_inbox: Option<JiraInboxConfig>

Jira inbox polling; requires jira, disabled when absent.

Implementations§

Source§

impl Config

Source

pub fn init() -> Result<Self>

Runs the setup wizard: pick modules, prompt each one’s settings, return the updated config (the caller saves it).

use kasl::libs::config::Config;

let config = Config::init()?;
config.save()?;
Source§

impl Config

Source

pub fn read() -> Result<Config>

Loads the config file, or defaults when none exists yet.

use kasl::libs::config::Config;

let config = Config::read()?;

if config.jira.is_some() {
    println!("Jira integration is configured");
}
Source

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

Writes the config as pretty-printed JSON, overwriting the file.

use kasl::libs::config::{Config, MonitorConfig};

let mut config = Config::read()?;
config.monitor = Some(MonitorConfig::default());
config.save()?;
Source

pub fn effective_ignore_names(&self) -> Vec<String>

Returns the ignore list for task discovery.

When task_discovery is not configured, returns the built-in defaults.

Source

pub fn add_ignore_names(&mut self, names: &[String]) -> Result<usize>

Appends unique names to the discovery ignore list and saves the config.

Uniqueness is determined by normalize_task_name. Returns how many new entries were added.

Source

pub fn set_app_global() -> Result<()>

Adds the executable’s directory to the global PATH.

Windows-shaped: checks the process PATH first, then edits the machine-level registry value via reg (which needs admin rights; the setup command downgrades a failure here to a warning).

use kasl::libs::config::Config;

Config::set_app_global()?;

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Config

Source§

fn default() -> Config

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Config

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Config

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more