Struct GitLabConfig 

pub struct GitLabConfig {
    pub access_token: String,
    pub api_url: String,
}

Configuration for GitLab API integration.

This structure holds the necessary information for connecting to GitLab instances, including both GitLab.com and self-hosted installations.

Security Notes

• Personal Access Tokens are stored in configuration files
• Tokens should be generated with minimal required scopes (read_user, read_repository)
• Consider using project-specific tokens for enhanced security
• Tokens can be revoked through GitLab’s interface if compromised

Supported Instances

• GitLab.com: Use https://gitlab.com as the API URL
• Self-hosted: Use your instance URL (e.g., https://gitlab.company.com)
• GitLab Enterprise: Same as self-hosted with enterprise features

Fields

access_token: String

Personal Access Token for GitLab API authentication.

This token must have the following scopes:

• read_user: To fetch user information and user ID
• read_repository: To access commit data and repository events

Generate tokens at: GitLab → User Settings → Access Tokens

api_url: String

Base URL of the GitLab instance.

Examples:

• GitLab.com: https://gitlab.com
• Self-hosted: https://gitlab.example.com
• Local development: http://localhost:8080

Do not include the /api/v4 path - it will be added automatically.

Implementations

impl GitLabConfig

pub fn module() -> ConfigModule

Returns the configuration module metadata for GitLab.

Used by the configuration system to identify and manage GitLab-specific settings during interactive setup.

Returns

A ConfigModule with GitLab identification information.

pub fn init(config: &Option<GitLabConfig>) -> Result<Self>

Runs an interactive configuration setup for GitLab integration.

Prompts the user for GitLab instance URL and personal access token, using existing configuration values as defaults if available. This method provides a user-friendly way to configure GitLab integration during initial setup or reconfiguration.

Interactive Prompts

1. Personal Access Token: Prompts for GitLab PAT with hidden input
2. API URL: Prompts for GitLab instance URL with validation

Both prompts will show existing values as defaults if configuration already exists, making it easy to update only specific values.

Arguments

• config - Existing GitLab configuration to use as defaults (if any)

Returns

• Result<Self> - New GitLab configuration with user input

Errors

Returns an error if:

• Terminal input/output fails
• User cancels the configuration process
• Input validation fails

Example

let existing_config = Some(GitLabConfig {
    access_token: "glpat-old-token".to_string(),
    api_url: "https://gitlab.com".to_string(),
});

let new_config = GitLabConfig::init(&existing_config)?;

Trait Implementations

impl Clone for GitLabConfig

fn clone(&self) -> GitLabConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitLabConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GitLabConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GitLabConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.