Skip to main content

ApprovalRequirement

Struct ApprovalRequirement 

Source
pub struct ApprovalRequirement {
    pub reason: Option<String>,
    pub required_approvers: u32,
    pub approver_groups: Vec<String>,
}
Expand description

The approval requirement recorded when a gate opened.

A gate opened without approvers carries no requirement at all; the default value (one approval from anyone allowed to answer the gate) applies.

§Examples

use ironflow_store::entities::ApprovalRequirement;

let requirement = ApprovalRequirement {
    reason: Some("amount > 10k".to_string()),
    required_approvers: 2,
    approver_groups: vec!["finance".to_string()],
};
assert!(!requirement.is_satisfied_by(1));
assert!(requirement.is_satisfied_by(2));
assert!(!requirement.allows_everyone());

Fields§

§reason: Option<String>

Why the handler asked for these approvers, for the audit trail. Never evaluated.

§required_approvers: u32

Number of distinct approvals needed to resolve the gate.

§approver_groups: Vec<String>

Groups whose members may vote. Empty means anyone allowed to answer the gate may vote.

Implementations§

Source§

impl ApprovalRequirement

Source

pub fn is_satisfied_by(&self, received: usize) -> bool

Whether received distinct approvals are enough to resolve the gate.

§Examples
use ironflow_store::entities::ApprovalRequirement;

let requirement = ApprovalRequirement::default();
assert!(!requirement.is_satisfied_by(0));
assert!(requirement.is_satisfied_by(1));
Source

pub fn allows_everyone(&self) -> bool

Whether the requirement puts no group restriction on voters.

§Examples
use ironflow_store::entities::ApprovalRequirement;

assert!(ApprovalRequirement::default().allows_everyone());

Trait Implementations§

Source§

impl Clone for ApprovalRequirement

Source§

fn clone(&self) -> ApprovalRequirement

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ApprovalRequirement

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ApprovalRequirement

Source§

fn default() -> ApprovalRequirement

One approval, from anyone, no reason.

Source§

impl<'de> Deserialize<'de> for ApprovalRequirement

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<ApprovalRequirement, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ApprovalRequirement

Source§

fn eq(&self, other: &ApprovalRequirement) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for ApprovalRequirement

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ApprovalRequirement

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

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

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

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

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

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

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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