Enum LinkStyle 

pub enum LinkStyle {
    Github,
    Gitlab,
    Stash,
    Cgit,
}

Determines the hyperlink style used in commit and issue links. Defaults to LinksStyle::Github

Example

let clog = Clog::new().unwrap();
clog.link_style(LinkStyle::Stash);

Variants

Github

Gitlab

Stash

Cgit

Implementations

impl LinkStyle

pub fn issue_link<S: AsRef<str>>(&self, issue: S, repo: Option<S>) -> String

Gets a hyperlink url to an issue in the specified format.

Example

let link = LinkStyle::Github;
let issue = link.issue_link("141", Some("https://github.com/thoughtram/clog"));

assert_eq!("https://github.com/thoughtram/clog/issues/141", issue);

pub fn commit_link<S: AsRef<str>>(&self, hash: S, repo: Option<S>) -> String

Gets a hyperlink url to a commit in the specified format.

Example

let link = LinkStyle::Github;
let commit = link.commit_link(
    "123abc891234567890abcdefabc4567898724",
    Some("https://github.com/clog-tool/clog-lib"),
);

assert_eq!(
    "https://github.com/thoughtram/clog/commit/123abc891234567890abcdefabc4567898724",
    commit
);

Trait Implementations

impl Clone for LinkStyle

fn clone(&self) -> LinkStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinkStyle

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

Formats the value using the given formatter.

impl Default for LinkStyle

fn default() -> LinkStyle

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LinkStyle

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LinkStyle

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

Formats the value using the given formatter.

impl FromStr for LinkStyle

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<LinkStyle, <Self as FromStr>::Err>

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

impl PartialEq for LinkStyle

fn eq(&self, other: &LinkStyle) -> 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 TryFrom<&str> for LinkStyle

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<LinkStyle, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for LinkStyle

impl Eq for LinkStyle

impl StructuralPartialEq for LinkStyle