Struct Client

pub struct Client<A> {
    api: A,
}

Expand description

A typed Forgejo backend over an injected Api implementation.

Fields§

Implementations§

Construct a backend.

Trait Implementations§

The desired repository state, decoded from the state document.

The adapter’s transport or API error.

The state read from the forge.

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

Check a configuration before any network access. Read more

Read the state that planning compares with config.

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

Perform one planned operation.

Returns a duplicate of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Returns the argument unchanged.

§

§

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

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

Calls U::from(self).

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

§

§

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

§

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

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

§

§

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

§

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

Struct Client Copy item path

Fields§

Implementations§

impl<A: Api> Client<A>

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

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

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

impl<A: Api> Client<A>

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

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

impl<A: Api> Client<A>

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

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

async fn recover_existing_rule( &self, repository: &RepoRef, name: &str, rule: &BranchRule, ) -> Result<(), ForgeError>

impl<A: Api> Client<A>

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

pub(super) async fn apply_deploy_keys( &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_repository( &self, repository: &RepoRef, live: &mut Live, ) -> Result<(), ForgeError>

pub(super) async fn read_topics( &self, repository: &RepoRef, topics: Option<&Vec<TopicName>>, 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_tag_protection( &self, repository: &RepoRef, config: Option<&TagProtection>, live: &mut Live, ) -> Result<(), ForgeError>

pub(super) async fn apply_tag_protection( &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

Trait Implementations§

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

type Config = Config

type Error = ForgeError

type Live = Live

type Operation = Operation

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

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

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

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

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

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

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

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

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

Auto Trait Implementations§

impl<A> Freeze for Client<A>where A: Freeze,

impl<A> RefUnwindSafe for Client<A>where A: RefUnwindSafe,

impl<A> Send for Client<A>where A: Send,

impl<A> Sync for Client<A>where A: Sync,

impl<A> Unpin for Client<A>where A: Unpin,

impl<A> UnsafeUnpin for Client<A>where A: UnsafeUnpin,

impl<A> UnwindSafe for Client<A>where A: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

fn into(self) -> U

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

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

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

impl<T> Same for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

Struct Client

impl<A> Freeze for Client<A>
where A: Freeze,

impl<A> RefUnwindSafe for Client<A>
where A: RefUnwindSafe,

impl<A> Send for Client<A>
where A: Send,

impl<A> Sync for Client<A>
where A: Sync,

impl<A> Unpin for Client<A>
where A: Unpin,

impl<A> UnsafeUnpin for Client<A>
where A: UnsafeUnpin,

impl<A> UnwindSafe for Client<A>
where A: UnwindSafe,

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

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

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

impl<T> CloneToUninit for T
where T: Clone,

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

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

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

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

impl<T> ToOwned for T
where T: Clone,

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

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

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