[−][src]Trait lenient_semver_parser::VersionBuilder

pub trait VersionBuilder<'input> {
    type Out;
    fn new() -> Self;
    fn build(self) -> Self::Out;

    fn set_major(&mut self, major: u64) { ... }
    fn set_minor(&mut self, minor: u64) { ... }
    fn set_patch(&mut self, patch: u64) { ... }
    fn add_additional(&mut self, num: u64) { ... }
    fn add_pre_release(&mut self, pre_release: &'input str) { ... }
    fn add_build(&mut self, build: &'input str) { ... }
}

Trait to abstract over version building.

The methods to implement in this trait represent the components of semver::Version, but allow for parsing into a custom type.

The trait is generic over the lifetime of the input string, so that one could parse into a version without having to allocate.

Most methods have a default implementation that does nothing and ignores the input. This can be used to implement some form of validation without needing to keep the result.

Example


struct IsPreRelease(bool);

impl<'input> VersionBuilder<'input> for IsPreRelease {
    type Out = bool;

    fn new() -> Self {
       IsPreRelease(false)
    }

    fn add_pre_release(&mut self, _input: &'input str) {
        self.0 = true;
    }

    fn build(self) -> Self::Out {
        self.0
    }
}

fn is_pre_release(v: &str) -> bool {
    lenient_semver_parser::parse::<IsPreRelease>(v).unwrap_or_default()
}

assert!(is_pre_release("1.2.3-pre"));
assert!(!is_pre_release("1.2.3"));
assert!(!is_pre_release("1.2.3+build"));

Associated Types

`type Out`

The return type of the final version.

Loading content...

Required methods

`fn new() -> Self`

Construct a new version builder.

The function must not fail and the version (if returned from VersionBuilder::build at this point) should represent something akin to "0.0.0"

`fn build(self) -> Self::Out`

Construct the final version.

Loading content...

Provided methods

`fn set_major(&mut self, major: u64)`

Set the major version component.

This method is the only required component and will be called before VersionBuilder::build.