Struct Phrase

pub struct Phrase { /* private fields */ }

A phrase that is made up of an adverb, adjective, noun.

When parsed from a slice it will lookup the sha parts in the dictionary. It knows how to properly format itself if a different case is selected.

Implementations

impl Phrase

pub fn with_case(self, f: Case) -> Self

Consumes the current phrase and returns a new one with a different case.

Example

use std::str::FromStr;
use git_release_name::{Phrase, Case};

let phrase = "1234".parse::<Phrase>().unwrap().with_case(Case::Upper);
assert_eq!(phrase.case(), Case::Upper);

pub fn adjective(&self) -> &str

The adjective component of this phrase

Example

use std::str::FromStr;
use git_release_name::Phrase;

let phrase: Phrase = "1234".parse().unwrap();
assert_eq!(phrase.adjective(), "courant");

pub fn adverb(&self) -> &str

The adverb component of this phrase

Example

use std::str::FromStr;
use git_release_name::Phrase;

let phrase: Phrase = "1234".parse().unwrap();
assert_eq!(phrase.adverb(), "ambitiously");

pub fn noun(&self) -> &str

The noun component of this phrase

Example

use std::str::FromStr;
use git_release_name::Phrase;

let phrase: Phrase = "1234".parse().unwrap();
assert_eq!(phrase.noun(), "gantlines");

pub fn case(&self) -> Case

The case the phrase will be formated with

Example

use std::str::FromStr;
use git_release_name::{Phrase, Case};

let phrase: Phrase = "1234".parse().unwrap();
assert_eq!(phrase.case(), Case::Lower);

Trait Implementations

impl Clone for Phrase

fn clone(&self) -> Phrase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Phrase

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

Formats the value using the given formatter.

impl Display for Phrase

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

Formats the value using the given formatter.

impl FromStr for Phrase

type Err = ParsePhraseError

The associated error which can be returned from parsing.

fn from_str(sha: &str) -> Result<Phrase, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Phrase

fn eq(&self, other: &Phrase) -> 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 Eq for Phrase

impl StructuralPartialEq for Phrase