Struct BudgetAllocation 

pub struct BudgetAllocation {
    pub category_id: CategoryId,
    pub period: BudgetPeriod,
    pub budgeted: Money,
    pub carryover: Money,
    pub notes: String,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
}

A budget allocation for a specific category in a specific period

Fields

category_id: CategoryId

The category this allocation is for

period: BudgetPeriod

The budget period

budgeted: Money

Amount budgeted/assigned to this category this period

carryover: Money

Amount carried over from the previous period (positive or negative)

notes: String

Notes for this period’s allocation

created_at: DateTime<Utc>

When this allocation was created

updated_at: DateTime<Utc>

When this allocation was last modified

Implementations

impl BudgetAllocation

pub fn new(category_id: CategoryId, period: BudgetPeriod) -> Self

Create a new budget allocation

pub fn with_budget( category_id: CategoryId, period: BudgetPeriod, budgeted: Money, ) -> Self

Create an allocation with an initial budget amount

pub fn set_budgeted(&mut self, amount: Money)

Set the budgeted amount

pub fn add_budgeted(&mut self, amount: Money)

Add to the budgeted amount

pub fn set_carryover(&mut self, amount: Money)

Set the carryover amount

pub fn total_budgeted(&self) -> Money

Get the total available in this category (budgeted + carryover) Note: Activity (spending) must be subtracted by the caller who has transaction data

pub fn validate(&self) -> Result<(), BudgetValidationError>

Validate the allocation

Trait Implementations

impl Clone for BudgetAllocation

fn clone(&self) -> BudgetAllocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BudgetAllocation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BudgetAllocation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BudgetAllocation

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

Formats the value using the given formatter.

impl Serialize for BudgetAllocation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.