Struct GlobalConfigFinalized 

pub struct GlobalConfigFinalized {

    pub allow_dirty: bool,
    pub current_version: Option<String>,
    pub parse_version_pattern: Regex,
    pub serialize_version_patterns: Vec<PythonFormatString>,
    pub search: RegexTemplate,
    pub replace: String,
    pub no_configured_files: bool,
    pub ignore_missing_files: bool,
    pub ignore_missing_version: bool,
    pub dry_run: bool,
    pub commit: bool,
    pub tag: bool,
    pub sign_tags: bool,
    pub tag_name: PythonFormatString,
    pub tag_message: PythonFormatString,
    pub commit_message: PythonFormatString,
    pub commit_args: Option<String>,
    pub setup_hooks: Vec<String>,
    pub pre_commit_hooks: Vec<String>,
    pub post_commit_hooks: Vec<String>,
    pub included_paths: Option<Vec<PathBuf>>,
    pub excluded_paths: Option<Vec<PathBuf>>,
    pub additional_files: Option<Vec<PathBuf>>,
}

Global configuration with defaults applied.

Fields

allow_dirty: bool

Don’t abort if working directory is dirty

current_version: Option<String>

Version that needs to be updated

parse_version_pattern: Regex

Regex parsing the version string

serialize_version_patterns: Vec<PythonFormatString>

How to serialize back to a version

search: RegexTemplate

Template for complete string to search

replace: String

Template for complete string to replace

no_configured_files: bool

Only replace the version in files specified on the command line.

When enabled, the files from the configuration file are ignored

ignore_missing_files: bool

Ignore any missing files when searching and replacing in files

ignore_missing_version: bool

Ignore any missing version when searching and replacing in files

dry_run: bool

Don’t write any files, just pretend

commit: bool

Commit to version control

tag: bool

Create a tag in version control

sign_tags: bool

Sign tags if created

tag_name: PythonFormatString

Tag name (only works with –tag)

tag_message: PythonFormatString

Tag message

commit_message: PythonFormatString

Commit message

commit_args: Option<String>

Extra arguments to commit command

setup_hooks: Vec<String>

Setup hooks

pre_commit_hooks: Vec<String>

Pre-commit hooks

post_commit_hooks: Vec<String>

Post-commit hooks

included_paths: Option<Vec<PathBuf>>

Included paths

excluded_paths: Option<Vec<PathBuf>>

Excluded paths

additional_files: Option<Vec<PathBuf>>

Additional files to add.

This is useful for files such as lockfiles, which should be regenerated after the version bump in a pre-commit hook.

Trait Implementations

impl Clone for GlobalConfigFinalized

fn clone(&self) -> GlobalConfigFinalized

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalConfigFinalized

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

Formats the value using the given formatter.

impl Default for GlobalConfigFinalized

fn default() -> Self

Returns the “default value” for a type.

impl Hash for GlobalConfigFinalized

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GlobalConfigFinalized

fn cmp(&self, other: &GlobalConfigFinalized) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for GlobalConfigFinalized

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for GlobalConfigFinalized

fn partial_cmp(&self, other: &GlobalConfigFinalized) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for GlobalConfigFinalized

impl StructuralPartialEq for GlobalConfigFinalized