[−][src]Struct codealong::Config

pub struct Config {
    pub merge_defaults: bool,
    pub churn_cutoff: u64,
    pub files: LinkedHashMap<String, GlobConfig>,
    pub authors: LinkedHashMap<String, AuthorConfig>,
}

Understands the .codealong/config.yml file format.

Example configuration:

github: ghempton/codealong
churn_cutoff: 14

merge_defaults: true

files:
  "**/*.rb":
    tags:
      - "ruby"
  "cassettes/**/*.yml":
    ignore: true
  "spec/**/*_spec.rb":
    tags:
      - "ruby"
      - "rspec"
      - "test"
  "**/*.css":
    tags:
      - "styles"
      - "css"
    weight: 0.5

authors:
  "Gordon Hempton <ghempton@gmail.com>":
    aliases:
      - "Gordon Hempton <gordon@hempton.com>"
    tags:
      - "team-apollo"

Fields

merge_defaults: boolchurn_cutoff: u64files: LinkedHashMap<String, GlobConfig>authors: LinkedHashMap<String, AuthorConfig>

Methods

`impl Config`[src]

`pub fn from_path(path: &Path) -> Result<Self, Error>`[src]

`pub fn from_file(file: &File) -> Result<Self, Error>`[src]

`pub fn base() -> Self`[src]

Base config with embedded defaults

`pub fn maybe_apply_base(&mut self)`[src]

`pub fn merge(&mut self, other: Config)`[src]

Merges in all file and author configs

`pub fn config_for_file(&self, path: &str) -> Option<FileConfig>`[src]

`pub fn config_for_identity(&self, identity: &Identity) -> Option<PersonConfig>`[src]

`pub fn config_for_github_login( &self, github_login: &str ) -> Option<PersonConfig>`[src]

`pub fn person_for_identity(&self, identity: &Identity) -> Person`[src]

`pub fn person_for_github_login(&self, github_login: &str) -> Person`[src]

`pub fn is_known(&self, identity: &Identity) -> bool`[src]

`pub fn is_github_login_known(&self, github_login: &str) -> bool`[src]

Trait Implementations

`impl Default for Config`[src]

`fn default() -> Config`[src]

`impl Clone for Config`[src]

`fn clone(&self) -> Config`[src]

`fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

Performs copy-assignment from source. Read more

`impl PartialEq<Config> for Config`[src]

`fn eq(&self, other: &Config) -> bool`[src]

`fn ne(&self, other: &Config) -> bool`[src]

`impl Debug for Config`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Serialize for Config`[src]

`fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer,` [src]

`impl<'de> Deserialize<'de> for Config`[src]

`fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where __D: Deserializer<'de>,` [src]

Auto Trait Implementations

`impl Send for Config`

`impl Sync for Config`

Blanket Implementations

`impl<T> From for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = !`

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T> Borrow for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> BorrowMut for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

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

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

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

`impl<T> DeserializeOwned for T where T: Deserialize<'de>,` [src]

`impl<T> SendSyncUnwindSafe for T where T: Send + Sync + UnwindSafe + ?Sized,` [src]

[−][src]Struct codealong::Config

Fields

Methods

impl Config[src]

pub fn from_path(path: &Path) -> Result<Self, Error>[src]

pub fn from_file(file: &File) -> Result<Self, Error>[src]

pub fn base() -> Self[src]

pub fn maybe_apply_base(&mut self)[src]

pub fn merge(&mut self, other: Config)[src]

pub fn config_for_file(&self, path: &str) -> Option<FileConfig>[src]

pub fn config_for_identity(&self, identity: &Identity) -> Option<PersonConfig>[src]

pub fn config_for_github_login( &self, github_login: &str) -> Option<PersonConfig>[src]

pub fn person_for_identity(&self, identity: &Identity) -> Person[src]

pub fn person_for_github_login(&self, github_login: &str) -> Person[src]

pub fn is_known(&self, identity: &Identity) -> bool[src]

pub fn is_github_login_known(&self, github_login: &str) -> bool[src]

Trait Implementations

impl Default for Config[src]

fn default() -> Config[src]

impl Clone for Config[src]

fn clone(&self) -> Config[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl PartialEq<Config> for Config[src]

fn eq(&self, other: &Config) -> bool[src]

fn ne(&self, other: &Config) -> bool[src]

impl Debug for Config[src]

fn fmt(&self, f: &mut Formatter) -> Result[src]

impl Serialize for Config[src]

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

impl<'de> Deserialize<'de> for Config[src]

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

Auto Trait Implementations

impl Send for Config

impl Sync for Config