Struct CompensationPlanV1 

pub struct CompensationPlanV1 {
    pub schema_version: String,
    pub compensation_plan_id: CompensationPlanId,
    pub effect_intent_id: EffectIntentId,
    pub citation: V25ConstitutionCitation,
    pub compensation_required: bool,
    pub compensation_class: CompensationClassV1,
    pub compensation_steps: Vec<String>,
    pub success_criteria: Vec<String>,
    pub owner_ref: String,
    pub latest_start: String,
    pub advisory_only: bool,
}

Plan describing the compensation steps required to reverse or mitigate a failed effect.

When compensation_required is true, compensation_steps must be non-empty.

Fields

schema_version: String

compensation_plan_id: CompensationPlanId

effect_intent_id: EffectIntentId

citation: V25ConstitutionCitation

Carries EffectiveConstitutionId and CompiledObligationSetId via the canonical v25 citation.

compensation_required: bool

compensation_class: CompensationClassV1

compensation_steps: Vec<String>

success_criteria: Vec<String>

owner_ref: String

latest_start: String

advisory_only: bool

Implementations

impl CompensationPlanV1

pub const SCHEMA_VERSION: &'static str = "CompensationPlanV1"

pub fn builder( compensation_plan_id: CompensationPlanId, effect_intent_id: EffectIntentId, citation: V25ConstitutionCitation, compensation_required: bool, compensation_class: CompensationClassV1, compensation_steps: Vec<String>, success_criteria: Vec<String>, owner_ref: impl Into<String>, latest_start: impl Into<String>, advisory_only: bool, ) -> CompensationPlanV1Builder

Returns a builder for a validated compensation plan artifact.

pub fn validate(&self) -> EffectValidationResult

Validates the owner-side invariants for a compensation plan.

Trait Implementations

impl Clone for CompensationPlanV1

fn clone(&self) -> CompensationPlanV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompensationPlanV1

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompensationPlanV1

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CompensationPlanV1

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for CompensationPlanV1

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CompensationPlanV1

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CompensationPlanV1