Struct DebtCovenant 

pub struct DebtCovenant {

    pub id: String,
    pub covenant_type: CovenantType,
    pub threshold: Decimal,
    pub measurement_frequency: Frequency,
    pub actual_value: Decimal,
    pub measurement_date: NaiveDate,
    pub is_compliant: bool,
    pub headroom: Decimal,
    pub waiver_obtained: bool,
    pub facility_id: Option<String>,
    pub entity_code: Option<String>,
    pub facility_name: Option<String>,
    pub outstanding_principal: Option<Decimal>,
    pub currency: Option<String>,
    pub period: Option<String>,
}

A financial covenant attached to a debt instrument.

Fields

id: String

Unique covenant identifier

covenant_type: CovenantType

Type of financial ratio being tested

threshold: Decimal

Covenant threshold value

measurement_frequency: Frequency

How often the covenant is tested

actual_value: Decimal

Most recent actual measured value

measurement_date: NaiveDate

Date the measurement was taken

is_compliant: bool

Whether the entity is in compliance

headroom: Decimal

Distance from the covenant threshold (positive = headroom, negative = breach)

waiver_obtained: bool

Whether a waiver was obtained for a breach

facility_id: Option<String>

Back-reference to the parent debt instrument ID

entity_code: Option<String>

Entity / company code

facility_name: Option<String>

Debt facility name

outstanding_principal: Option<Decimal>

Outstanding principal at measurement date

currency: Option<String>

Currency of the facility

period: Option<String>

Fiscal period (e.g. “2024-06”)

Implementations

impl DebtCovenant

pub fn new( id: impl Into<String>, covenant_type: CovenantType, threshold: Decimal, measurement_frequency: Frequency, actual_value: Decimal, measurement_date: NaiveDate, ) -> Self

Creates a new debt covenant.

pub fn with_waiver(self, waiver: bool) -> Self

Sets the waiver flag.

pub fn with_facility( self, facility_id: impl Into<String>, entity_code: impl Into<String>, facility_name: impl Into<String>, outstanding_principal: Decimal, currency: impl Into<String>, period: impl Into<String>, ) -> Self

Set the parent debt facility details for standalone graph export.

pub fn update_compliance(&mut self)

Recomputes compliance and headroom from current values.

Trait Implementations

impl Clone for DebtCovenant

fn clone(&self) -> DebtCovenant

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DebtCovenant

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DebtCovenant

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DebtCovenant

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToNodeProperties for DebtCovenant

fn node_type_name(&self) -> &'static str

Entity type name (snake_case), e.g. "uncertain_tax_position".

fn node_type_code(&self) -> u16

Numeric entity type code for registry, e.g. 416.

fn to_node_properties(&self) -> HashMap<String, GraphPropertyValue>

Convert all fields to a property map with camelCase keys.