Struct IncomeExpectation 

pub struct IncomeExpectation {
    pub id: IncomeId,
    pub period: BudgetPeriod,
    pub expected_amount: Money,
    pub notes: String,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
}

Expected income for a budget period

Fields

id: IncomeId

period: BudgetPeriod

expected_amount: Money

notes: String

created_at: DateTime<Utc>

updated_at: DateTime<Utc>

Implementations

impl IncomeExpectation

pub fn new(period: BudgetPeriod, expected_amount: Money) -> Self

Create a new income expectation

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

Set the expected amount

pub fn set_notes(&mut self, notes: impl Into<String>)

Set notes

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

Validate the income expectation

pub fn is_over_budget(&self, total_budgeted: Money) -> bool

Check if a budgeted amount exceeds expected income

pub fn budget_difference(&self, total_budgeted: Money) -> Money

Get the difference between expected income and budgeted amount Positive = under budget (good), Negative = over budget (warning)

Trait Implementations

impl Clone for IncomeExpectation

fn clone(&self) -> IncomeExpectation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IncomeExpectation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IncomeExpectation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for IncomeExpectation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.