Struct Client 

pub struct Client<A> {
    api: A,
    caller: Option<Caller>,
}

A typed GitHub backend over an injected API implementation.

Fields

api: A

caller: Option<Caller>

Implementations

impl<A: Api> Client<A>

pub(super) async fn read_access( &self, repository: &RepoRef, config: Option<&Access<Permission>>, live: &mut Live, ) -> Result<(), ForgeError>

pub(super) async fn read_caller( &self, organization: &str, ) -> Result<Caller, ForgeError>

pub(super) async fn apply_access( &self, repository: &RepoRef, operation: &Operation, ) -> Result<(), ForgeError>

impl<A: Api> Client<A>

pub(super) async fn read_actions( &self, repository: &RepoRef, config: Option<&Actions>, live: &mut Live, ) -> Result<(), ForgeError>

async fn read_group<G: ActionsGroup>( &self, repository: &RepoRef, declared: Option<&G>, live: &mut ActionsLive, ) -> Result<(), ForgeError>

pub(super) async fn apply_actions( &self, repository: &RepoRef, group: &Group, ) -> Result<(), ForgeError>

impl<A: Api> Client<A>

pub(super) async fn read_autolinks( &self, repository: &RepoRef, config: Option<&Autolinks>, live: &mut Live, ) -> Result<(), ForgeError>

pub(super) async fn apply_autolinks( &self, repository: &RepoRef, operation: &Operation, ) -> Result<(), ForgeError>

impl<A: Api> Client<A>

pub(super) async fn read_custom_properties( &self, repository: &RepoRef, config: Option<&BTreeMap<String, PropertyValue>>, live: &mut Live, ) -> Result<(), ForgeError>

pub(super) async fn apply_custom_properties( &self, repository: &RepoRef, operation: &Operation, ) -> Result<(), ForgeError>

impl<A: Api> Client<A>

pub(super) async fn read_environments( &self, repository: &RepoRef, config: Option<&Environments>, live: &mut Live, ) -> Result<(), ForgeError>

pub(super) async fn apply_environments( &self, repository: &RepoRef, operation: &Operation, ) -> Result<(), ForgeError>

impl<A: Api> Client<A>

pub(super) async fn read_labels( &self, repository: &RepoRef, config: Option<&Labels<Label>>, live: &mut Live, ) -> Result<(), ForgeError>

pub(super) async fn apply_labels( &self, repository: &RepoRef, operation: &Operation, ) -> Result<(), ForgeError>

impl<A: Api> Client<A>

pub(super) async fn read_pages( &self, repository: &RepoRef, config: Option<&Pages>, live: &mut Live, ) -> Result<(), ForgeError>

pub(super) async fn apply_pages( &self, repository: &RepoRef, operation: &Operation, ) -> Result<(), ForgeError>

impl<A: Api> Client<A>

pub(super) async fn read_repository( &self, repository: &RepoRef, config: &Repository, live: &mut Live, ) -> Result<(), ForgeError>

pub(super) async fn apply_repository( &self, repository: &RepoRef, operation: &Operation, ) -> Result<(), ForgeError>

impl<A: Api> Client<A>

pub(super) async fn read_rulesets( &self, repository: &RepoRef, config: Option<&Rulesets>, live: &mut Live, ) -> Result<(), ForgeError>

pub(super) async fn apply_rulesets( &self, repository: &RepoRef, operation: &Operation, ) -> Result<(), ForgeError>

impl<A: Api> Client<A>

pub(super) async fn read_security( &self, repository: &RepoRef, config: &Security, live: &mut Live, ) -> Result<(), ForgeError>

pub(super) async fn apply_security( &self, repository: &RepoRef, operation: &Operation, ) -> Result<(), ForgeError>

impl<A: Api> Client<A>

pub(super) async fn read_variables( &self, repository: &RepoRef, config: Option<&Variables>, environments: Option<&Environments>, live: &mut Live, ) -> Result<(), ForgeError>

pub(super) async fn apply_variables( &self, repository: &RepoRef, operation: &Operation, ) -> Result<(), ForgeError>

impl<A: Api> Client<A>

pub(super) async fn read_webhooks( &self, repository: &RepoRef, config: Option<&Webhooks>, live: &mut Live, ) -> Result<(), ForgeError>

pub(super) async fn apply_webhooks( &self, repository: &RepoRef, operation: &Operation, ) -> Result<(), ForgeError>

impl<A> Client<A>

pub const fn new(api: A) -> Self

Construct a backend.

pub fn acting_as(self, caller: Caller) -> Self

Act as caller instead of asking the API who the token belongs to.

Trait Implementations

impl<A: Api> Backend for Client<A>

type Config = Config

The desired repository state, decoded from the state document.

type Error = ForgeError

The adapter’s transport or API error.

type Live = Live

The state read from the forge.

type Operation = Operation

One labelled write. The label names the resource the write changes.

fn validate(config: &Config) -> Result<(), Self::Error>

Check a configuration before any network access.

async fn read( &self, repository: &RepoRef, config: &Config, ) -> Result<Live, Self::Error>

Read the state that planning compares with config.

fn plan(config: &Config, live: &Live) -> Planned<Operation>

Compare the desired and the live state without any I/O.

async fn apply( &self, repository: &RepoRef, operation: &Operation, ) -> Result<(), Self::Error>

Perform one planned operation.

impl<A: Clone> Clone for Client<A>

fn clone(&self) -> Client<A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for Client<A>

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

Formats the value using the given formatter.