Struct Entitlement 

pub struct Entitlement {
    pub plan: i32,
    pub status: i32,
    pub current_period_end: Option<Timestamp>,
    pub billing_interval: Option<String>,
    pub billing_interval_count: Option<i32>,
    pub currency: Option<String>,
    pub amount: Option<i64>,
    pub provider_subscription_id: Option<String>,
}

The account-level entitlement applied for a subject.

Fields

plan: i32

status: i32

current_period_end: Option<Timestamp>

billing_interval: Option<String>

Provider billing cadence copied from the subject’s subscription row: “day”, “week”, “month”, or “year”.

billing_interval_count: Option<i32>

currency: Option<String>

ISO 4217 currency code normalized to lowercase.

amount: Option<i64>

Subscription amount in the smallest unit of currency.

provider_subscription_id: Option<String>

Opaque provider identifier for server-side subscription operations. This is not a credential or proof of ownership. A server using its organization token MUST re-bind this id to the authenticated subject before mutation.

Implementations

impl Entitlement

pub fn plan(&self) -> Plan

Returns the enum value of plan, or the default if the field is set to an invalid enum value.

pub fn set_plan(&mut self, value: Plan)

Sets plan to the provided enum value.

pub fn status(&self) -> SubscriptionStatus

Returns the enum value of status, or the default if the field is set to an invalid enum value.

pub fn set_status(&mut self, value: SubscriptionStatus)

Sets status to the provided enum value.

pub fn billing_interval(&self) -> &str

Returns the value of billing_interval, or the default value if billing_interval is unset.

pub fn billing_interval_count(&self) -> i32

Returns the value of billing_interval_count, or the default value if billing_interval_count is unset.

pub fn currency(&self) -> &str

Returns the value of currency, or the default value if currency is unset.

pub fn amount(&self) -> i64

Returns the value of amount, or the default value if amount is unset.

pub fn provider_subscription_id(&self) -> &str

Returns the value of provider_subscription_id, or the default value if provider_subscription_id is unset.

Trait Implementations

impl Clone for Entitlement

fn clone(&self) -> Entitlement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entitlement

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

Formats the value using the given formatter.

impl Default for Entitlement

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Entitlement

impl Hash for Entitlement

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

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 Message for Entitlement

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Entitlement

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Entitlement