Enum Assignee 

pub enum Assignee {
    User(String),
    Group(String),
}

Who an approval gate is currently assigned to: an individual user or a group.

The distinction is carried in the type rather than in a free-form string, so callers cannot confuse a user with a group. On the wire and in the store the value is a single prefixed string — user:{name} for Assignee::User and group:{name} for Assignee::Group — which keeps the database column a plain TEXT and the OpenAPI type a plain string.

Whether an approver is allowed to resolve a gate is decided by the API layer, which reads this type: a gate assigned to a Assignee::User can be answered by that user and by whoever holds an active ApprovalDelegation from them, while a Assignee::Group gate stays admin-only.

Examples

use ironflow_store::entities::Assignee;

let alice = Assignee::user("alice");
assert_eq!(alice.to_string(), "user:alice");
assert_eq!(alice.name(), "alice");

let sre: Assignee = "group:sre-oncall".parse()?;
assert_eq!(sre, Assignee::group("sre-oncall"));
assert!(sre.is_group());

Variants

User(String)

An individual user, identified by an opaque name.

Group(String)

A group, identified by an opaque name.

Implementations

impl Assignee

pub fn user(name: impl Into<String>) -> Assignee

Build a Assignee::User from any string-like value.

Examples

use ironflow_store::entities::Assignee;

assert_eq!(Assignee::user("alice").to_string(), "user:alice");

pub fn group(name: impl Into<String>) -> Assignee

Build a Assignee::Group from any string-like value.

Examples

use ironflow_store::entities::Assignee;

assert_eq!(Assignee::group("sre").to_string(), "group:sre");

pub fn name(&self) -> &str

The bare name, without the user:/group: prefix.

Examples

use ironflow_store::entities::Assignee;

assert_eq!(Assignee::group("sre").name(), "sre");

pub fn is_user(&self) -> bool

Whether this assignee is an individual user.

Examples

use ironflow_store::entities::Assignee;

assert!(Assignee::user("alice").is_user());
assert!(!Assignee::group("sre").is_user());

pub fn is_group(&self) -> bool

Whether this assignee is a group.

Examples

use ironflow_store::entities::Assignee;

assert!(Assignee::group("sre").is_group());
assert!(!Assignee::user("alice").is_group());

Trait Implementations

impl Clone for Assignee

fn clone(&self) -> Assignee

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Assignee

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Assignee

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Assignee

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

Formats the value using the given formatter.

impl Eq for Assignee

impl FromStr for Assignee

type Err = AssigneeParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Assignee, <Assignee as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Assignee

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Assignee

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Assignee

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.

impl StructuralPartialEq for Assignee

impl TryFrom<String> for Assignee

type Error = AssigneeParseError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<Assignee, <Assignee as TryFrom<String>>::Error>

Performs the conversion.