Enum GovernanceMailKind 

#[repr(i32)]
pub enum GovernanceMailKind {
    Unspecified = 0,
    PayoutApproval = 1,
    PayoutOutcome = 2,
    ApprovalTokenBurned = 3,
    PaymentConsent = 4,
    PaymentApproval = 5,
    FeePolicyApproval = 6,
    FeePolicyNotice = 7,
    PaymentOutcome = 8,
}

The typed governance mails this plane knows how to render.

Variants

Unspecified = 0

PayoutApproval = 1

The money plane asking an owner to approve a revenue payout.

PayoutOutcome = 2

The money plane telling the owners a payout was decided, executed or failed.

ApprovalTokenBurned = 3

The money plane warning the owners that a token burned on failed code attempts.

PaymentConsent = 4

The money plane asking ONE user to consent to a payment that moves THEIR money.

The only kind here that is not addressed to the consilium, and therefore the only one whose recipient rule is IDENTITY rather than role: an ordinary investor consents to their own transfer, and no seat is involved. See PaymentConsentMail.

PaymentApproval = 5

The money plane asking an owner to approve a PAYMENT whose source is fund-owned money — the consilium counterpart of PAYMENT_CONSENT. Addressed to a seated owner under the same rule as the payout kinds; what differs is only what the mail describes: two ends of a transfer in words, not a rail and an address. See PaymentApprovalMail for why the payout template cannot carry it.

FeePolicyApproval = 6

The money plane asking an owner to approve NEW FEE TERMS for a fund — the consilium over the price every investor in that fund pays. Addressed like PAYMENT_APPROVAL: a seated owner at a verified address, because the mail carries a link and the code that arms it. See FeePolicyApprovalMail.

FeePolicyNotice = 7

The money plane telling ONE investor that the fee terms of a fund they hold are changing. Addressed by IDENTITY like PAYMENT_CONSENT — the recipient must BE the investor the payload names — and, like a consent, it leaves an in-app trace. It asks for nothing and carries no code: it is notice. See FeePolicyNoticeMail.

PaymentOutcome = 8

The money plane telling the subject of a payment, or a staff member, that the payment was cancelled before it moved anything because its consent could no longer be given: the consent link burned on wrong codes, or was invalidated. Addressed to the subject the payload names OR to an admin/owner, at a verified address; the subject’s copy leaves an in-app trace like a consent. No link and no code. See PaymentOutcomeMail.

Implementations

impl GovernanceMailKind

pub const fn is_valid(value: i32) -> bool

Returns true if value is a variant of GovernanceMailKind.

pub fn from_i32(value: i32) -> Option<GovernanceMailKind>

👎Deprecated:

Use the TryFrom<i32> implementation instead

Converts an i32 to a GovernanceMailKind, or None if value is not a valid variant.

impl GovernanceMailKind

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<GovernanceMailKind>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for GovernanceMailKind

fn clone(&self) -> GovernanceMailKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for GovernanceMailKind

impl Debug for GovernanceMailKind

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

Formats the value using the given formatter.

impl Default for GovernanceMailKind

fn default() -> GovernanceMailKind

Returns the “default value” for a type.

impl Eq for GovernanceMailKind

impl Hash for GovernanceMailKind

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 Ord for GovernanceMailKind

fn cmp(&self, other: &GovernanceMailKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for GovernanceMailKind

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for GovernanceMailKind

fn partial_cmp(&self, other: &GovernanceMailKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for GovernanceMailKind

impl TryFrom<i32> for GovernanceMailKind

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<GovernanceMailKind, UnknownEnumValue>

Performs the conversion.