Skip to main content

GitLab

Struct GitLab 

Source
pub struct GitLab { /* private fields */ }
Expand description

A GitLab client that resolves credentials from the workflow’s secret store.

Wraps AsyncGitlab and provides a convenience op method to turn any endpoint into a tracked Operation.

§Examples

use ironflow_ops_gitlab::GitLab;
use ironflow_core::operation::{OperationContext, NoopSecretResolver};
use std::sync::Arc;

let ctx = OperationContext::new(Arc::new(NoopSecretResolver));

// gitlab.com (default)
let gitlab = GitLab::from_context(&ctx).await?;

// Self-hosted
let gitlab = GitLab::from_context_with_host(&ctx, "gitlab.example.com").await?;

Implementations§

Source§

impl GitLab

Source

pub async fn from_context( ctx: &OperationContext, ) -> Result<Self, OperationError>

Build a client from an OperationContext, defaulting to gitlab.com.

Reads the gitlab_token secret from the workflow’s secret store.

§Errors

Returns OperationError::Secret if the token is missing, or OperationError::Http if the client cannot be built.

Source

pub async fn from_context_with_host( ctx: &OperationContext, host: &str, ) -> Result<Self, OperationError>

Build a client from an OperationContext with a custom host.

§Errors

Returns OperationError::Secret if the token is missing, or OperationError::Http if the client cannot be built.

Source

pub async fn new(token: &str, host: &str) -> Result<Self, OperationError>

Build a client with an explicit token and host.

§Errors

Returns OperationError::Http if the client cannot be built.

§Examples
use ironflow_ops_gitlab::GitLab;

let gitlab = GitLab::new("glpat-xxxx", "gitlab.com").await?;
Source

pub fn client(&self) -> &AsyncGitlab

The underlying AsyncGitlab client.

Use this with AsyncQuery::query_async for typed endpoint calls.

Source

pub fn op<E>(&self, endpoint: E) -> GitLabOp<E>

Wrap an endpoint as a tracked Operation.

The returned GitLabOp implements Operation so it can be passed to WorkflowContext::operation() for step lifecycle tracking.

§Examples
use ironflow_ops_gitlab::GitLab;
use gitlab::api::projects;

let gitlab = GitLab::new("glpat-xxxx", "gitlab.com").await?;
let endpoint = projects::Project::builder().project(42).build().unwrap();
let op = gitlab.op(endpoint);

Trait Implementations§

Source§

impl Debug for GitLab

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more