Struct gitforge::forge::Config

pub struct Config {
    pub token: Option<TokenConfig>,
    pub kind: Option<Kind>,
    pub host: String,
    pub _non_exhaustive: (),
}

Instructions for how to connect to a forge

Fields

token: Option<TokenConfig>

Access token (secret).

If left as None, Config::forge() will do the work of load_default_token.

kind: Option<Kind>

The kind of forge (ie, the protocol to speak).

Currently, None is not supported. In the future omitting kind might result in auto-guessing from host.

host: String

Hostname.

Eg, gitlab.com, github.com, salsa.debian.org.

_non_exhaustive: ()

Do not specify this field. Instead, say ..Default::default(). New fields may be added and this will not be considered a semver break.

Implementations

impl Config

pub fn forge(&self) -> Result<Box<dyn Forge + 'static>, FE>

Main constructor for a Forge

impl Config

pub fn default_token_path(&self) -> Result<PathBuf, Error>

Calculate the default path for finding a secret token.

On Unix this is ~/.config/gitforge/FORGE_EXAMPLE_ORG.KIND-token where FORGE_EXAMPLE_ORG is host with dots replaced with underscores.

pub fn load_default_token(&mut self) -> Result<&mut Self, Error>

Load the default token, updating this Config.

It is not normally necessary to call this, because Config::new() will automatically laod and use the appropriate token anyway, according to the same algorithm.

Arranges that self.token is either Anonymous or Value, by establishing a suitable default, and loading the token from a file, as necessary.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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

Serialize this value into the given Serde serializer.