Struct gh_auditor::AuditorBuilder

pub struct AuditorBuilder<'a> { /* fields omitted */ }

A builder struct for the Auditor. Allows you to configure GitHub organisation, underlying http client, audit configuration, and authentication token.

Methods

impl<'a> AuditorBuilder<'a>

pub fn new<I: Into<String>>(org: I) -> Self

Creates a default AuditorBuilder.

Example

use gh_auditor::{Auditor, AuditorBuilder};

let auditor: Auditor = AuditorBuilder::new("rust-lang").finish()?;

pub fn auth_key<I: Into<String>>(self, auth_key: I) -> Self

Set the authentication key used for GitHub requests. Auditor requires at least admin:read access on the organisation. (Default: $GITHUB_AUTH_KEY environment variable)

pub fn client<I: Into<Cow<'a, Client>>>(self, client: I) -> Self

Sets the http client, if desired. (Default: reqwest::Client::new())

pub fn config(self, config: Config) -> Self

Sets the initial configuration. See Config for information on audit configuration. (Default: Config::default())

pub fn finish(self) -> Result<Auditor<'a>>

Consume AuditorBuilder and construct Auditor with configuration or default values, and query for organisation information.

Errors

If no authentication key was not provided or invalid.