Struct FormatOptions 

pub struct FormatOptions {
    pub include_op: bool,
    pub include_minor: bool,
    pub include_scope: bool,
    pub include_patch: bool,
    pub include_prerelease: bool,
    pub include_build: bool,
    pub pad_major: Option<u8>,
    pub pad_minor: Option<u8>,
    pub pad_patch: Option<u8>,
    pub separator: char,
}

Options for formatting a version into a string.

Fields

include_op: bool

Whether to include the comparison operator, and wildcard placeholders, for requirements.

include_minor: bool

Whether to include the minor version.

include_scope: bool

Whether to include the scope.

include_patch: bool

Whether to include the patch version.

include_prerelease: bool

Whether to include the pre-release information.

include_build: bool

Whether to include the build metadata.

pad_major: Option<u8>

Whether to pad the major version with leading zeros, and if so, how many digits to pad to.

pad_minor: Option<u8>

Whether to pad the minor version with leading zeros, and if so, how many digits to pad to.

pad_patch: Option<u8>

Whether to pad the patch version with leading zeros, and if so, how many digits to pad to.

separator: char

The separator character to use between version components.

Implementations

impl FormatOptions

pub fn new(kind: VersionKind) -> FormatOptions

Create a new FormatOptions instance with the specified version kind.

pub fn calendar() -> FormatOptions

Returns a new FormatOptions instance with default settings for calendar versioning.

pub fn semantic() -> FormatOptions

Returns a new FormatOptions instance with default settings for semantic versioning.

Trait Implementations

impl Clone for FormatOptions

fn clone(&self) -> FormatOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormatOptions

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

Formats the value using the given formatter.

impl Default for FormatOptions

fn default() -> FormatOptions

Returns the “default value” for a type.