Struct Client 

pub struct Client { /* private fields */ }

Implementations

impl Client

pub fn new(api_token: &ApiToken) -> Result<Self, Error>

Errors

Returns an error if the api token is not a valid header or there’s an issue constructing the client.

Examples found in repository

examples/list-projects.rs (line 9)

async fn main() -> Result<()> {
    let client = Client::new(&ApiToken::from_env()?)?;
    //eprintln!("{:?}", &client);

    let res = client
        .list_pipelines(PipelineListRequest {
            org_slug: "gh/remind101".into(),
            ..Default::default()
        })
        .await
        .context("error listing pipelines")?;
    //eprintln!("{:?}", &res);

    for pipeline in res.items {
        println!("{}", pipeline.project_slug);
        let res = client
            .list_workflows_by_pipeline_id(WorkflowListRequest {
                pipeline_id: pipeline.id,
                ..Default::default()
            })
            .await
            .context("error getting workflows for pipeline")?;
        //eprintln!("{:?}", &res);

        for workflow in res.items {
            println!("{}", workflow.name);

            let res =
                client.get_workflow_timeseries(WorkflowTimeseriesRequest {
                    project_slug: workflow.project_slug,
                    branch: Some("master".into()),
                    ..Default::default()
                });
            //eprintln!("{:?}", &res);
        }
    }

    Ok(())
}

pub async fn get<T: Requestable>(&self, params: &T) -> Result<Response, Error>

Errors

Returns an error if anything goes wrong with the request.

pub async fn delete<T: Requestable>( &self, params: &T, ) -> Result<Response, Error>

Send an HTTP DELETE request.

Errors

Returns an error if anything goes wrong with the request.

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.

impl Insights for Client

fn get_workflow_timeseries<'life0, 'async_trait, T>( &'life0 self, params: T, ) -> Pin<Box<dyn Future<Output = Result<WorkflowTimeseriesResponse, Error>> + Send + 'async_trait>>

where T: 'async_trait + Borrow<WorkflowTimeseriesRequest> + Send + Sync, Self: 'async_trait, 'life0: 'async_trait,

Workflow timeseries data

impl Pipeline for Client

fn list_pipelines<'life0, 'async_trait>( &'life0 self, params: PipelineListRequest, ) -> Pin<Box<dyn Future<Output = Result<PipelineListResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get a list of pipelines.

Returns all pipelines for the most recently built projects (max 250) you follow in an organization.

fn list_workflows_by_pipeline_id<'life0, 'async_trait>( &'life0 self, params: WorkflowListRequest, ) -> Pin<Box<dyn Future<Output = Result<WorkflowListResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get a pipeline’s workflows.

Returns a paginated list of workflows by pipeline ID.

impl Project for Client

fn get_project<'life0, 'async_trait>( &'life0 self, params: ProjectGetRequest, ) -> Pin<Box<dyn Future<Output = Result<ProjectGetResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get information about a project.

fn list_envvars<'life0, 'async_trait>( &'life0 self, params: ProjectListEnvvarsRequest, ) -> Pin<Box<dyn Future<Output = Result<ProjectListEnvvarsResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

List env vars for for a project.

fn delete_envvar<'life0, 'async_trait>( &'life0 self, params: ProjectDeleteEnvvarRequest, ) -> Pin<Box<dyn Future<Output = Result<ProjectDeleteEnvvarResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Delete an env var from a repo.