Skip to main content

RulesetsApi

ephemeris_forge_github::api::operations::rulesets

Trait RulesetsApi 

Source 
pub trait RulesetsApi {
    // Required methods
    fn create_ruleset(
        &self,
        repository: &RepoRef,
        name: &str,
        ruleset: &Definition,
    ) -> impl Future<Output = Result<(), ForgeError>> + Send;
    fn delete_ruleset(
        &self,
        repository: &RepoRef,
        id: u64,
    ) -> impl Future<Output = Result<(), ForgeError>> + Send;
    fn rulesets(
        &self,
        repository: &RepoRef,
    ) -> impl Future<Output = Result<Vec<Ruleset>, ForgeError>> + Send;
    fn update_ruleset(
        &self,
        repository: &RepoRef,
        id: u64,
        name: &str,
        ruleset: &Definition,
        unmanaged_rules: &[Value],
    ) -> impl Future<Output = Result<(), ForgeError>> + Send;
}
Expand description

The rulesets operations of the GitHub API.

Required Methods§

Source

fn create_ruleset( &self, repository: &RepoRef, name: &str, ruleset: &Definition, ) -> impl Future<Output = Result<(), ForgeError>> + Send

Create a ruleset with its complete desired configuration.

Source

fn delete_ruleset( &self, repository: &RepoRef, id: u64, ) -> impl Future<Output = Result<(), ForgeError>> + Send

Delete the ruleset id.

Source

fn rulesets( &self, repository: &RepoRef, ) -> impl Future<Output = Result<Vec<Ruleset>, ForgeError>> + Send

Read the repository’s current rulesets.

Source

fn update_ruleset( &self, repository: &RepoRef, id: u64, name: &str, ruleset: &Definition, unmanaged_rules: &[Value], ) -> impl Future<Output = Result<(), ForgeError>> + Send

Replace the ruleset id with its complete desired configuration and the live rules that the configuration cannot declare.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§