Struct nextver::Format

pub struct Format<'fs, S: Scheme> { /* private fields */ }

A Format describes the structure of a version, comprised of specifiers and literal text.

Later, the Format can be used to parse a version string into a Version struct.

Implementations

impl<'fs, S: Scheme> Format<'fs, S>

pub fn new_version<'vs>( &self, version_str: &'vs str ) -> Result<Version<'vs, S>, VersionError>

Parses a version string with this format and return a Version object.

A version string is valid for a format if it matches the format exactly. This means that:

• Specifiers (e.g. <MAJOR>) in the format are replaced with the numeric values. See the table for how these values are expressed (such as zero-padding).

  Note: The values in version_str are not validated to be actual dates. For example, 2021.02.31 is valid for the format <YYYY>.<MM>.<DD>, even though February 31st does not exist.

• Literal text in the format must match the version string exactly.

Errors

• If the version string does not match the format string, returns a VersionError::VersionFormatMismatch.

Trait Implementations

impl<'fs, S: Clone + Scheme> Clone for Format<'fs, S>

fn clone(&self) -> Format<'fs, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'fs, S: Debug + Scheme> Debug for Format<'fs, S>

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

Formats the value using the given formatter.

impl<'fs, S: Scheme> Display for Format<'fs, S>

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

Display a format as a format string.

Example

use nextver::prelude::*;

let format_str = "<YYYY>.<MM>.<DD>";
let format = Cal::new_format(format_str).unwrap();
assert_eq!(format_str, format.to_string());

impl<'fs, S: PartialEq + Scheme> PartialEq for Format<'fs, S>

fn eq(&self, other: &Format<'fs, S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'fs, S: Eq + Scheme> Eq for Format<'fs, S>

impl<'fs, S: Scheme> StructuralPartialEq for Format<'fs, S>