Struct git_cliff_core::config::Remote

pub struct Remote {
    pub owner: String,
    pub repo: String,
    pub token: Option<SecretString>,
}

A single remote.

Fields

owner: String

Owner of the remote.

repo: String

Repository name.

token: Option<SecretString>

Access token.

Implementations

impl Remote

pub fn new<S: Into<String>>(owner: S, repo: S) -> Self

Constructs a new instance.

pub fn is_set(&self) -> bool

Returns true if the remote has an owner and repo.

Trait Implementations

impl Clone for Remote

fn clone(&self) -> Remote

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Remote

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

Formats the value using the given formatter.

impl Default for Remote

fn default() -> Remote

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Remote

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Remote

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

Formats the value using the given formatter.

impl PartialEq for Remote

fn eq(&self, other: &Self) -> 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 Serialize for Remote

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Remote> for BitbucketClient

Available on crate feature bitbucket and (crate features github or gitlab or bitbucket) only.

Constructs a Bitbucket client from the remote configuration.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(remote: Remote) -> Result<Self>

Performs the conversion.

impl TryFrom<Remote> for GitHubClient

Available on crate feature github and (crate features github or gitlab or bitbucket) only.

Constructs a GitHub client from the remote configuration.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(remote: Remote) -> Result<Self>

Performs the conversion.

impl TryFrom<Remote> for GitLabClient

Available on crate feature gitlab and (crate features github or gitlab or bitbucket) only.

Constructs a GitLab client from the remote configuration.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(remote: Remote) -> Result<Self>

Performs the conversion.