Struct Indicator 

pub struct Indicator {

    pub id: String,
    pub objective_id: String,
    pub name: String,
    pub unit: String,
    pub direction: i32,
    pub frequency: i32,
    pub owner_user_id: String,
    pub evidence_source: Option<EvidenceSource>,
    pub rationale: String,
    pub strategic_meaning: String,
    pub interpretation_guidance: String,
    pub perverse_behavior_note: String,
    pub verification_state: i32,
    pub created_at: Option<Timestamp>,
    pub updated_at: Option<Timestamp>,
    pub target: Option<f64>,
}

A declared way of observing whether an objective holds. Several per objective is the intended shape: indicators are individually incomplete and are meant to compensate for one another.

Fields

id: String

Unique identifier for the indicator.

objective_id: String

Objective this indicator hangs from.

name: String

Short name for the indicator. Required. Constraints: Max length 200 characters.

unit: String

Unit the readings are expressed in (e.g. “percent”, “days”, “incidents”). Free text so that existing measures can be carried over unchanged. Constraints: Max length 50 characters.

direction: i32

Which direction of movement is the desired one.

frequency: i32

How often a reading is expected.

owner_user_id: String

ID of the user accountable for the indicator. Optional.

evidence_source: Option<EvidenceSource>

Where readings come from. Required.

rationale: String

Why this indicator was chosen over the alternatives. Constraints: Max length 2000 characters.

strategic_meaning: String

What the indicator is meant to say about the objective. Constraints: Max length 2000 characters.

interpretation_guidance: String

How a reading should be read, including what it does not cover. Constraints: Max length 2000 characters.

perverse_behavior_note: String

The behaviour this indicator could encourage if it were optimized on its own. Pre-filled by the server where a structural weakness in the evidence source implies one, always editable, never required. Constraints: Max length 2000 characters.

verification_state: i32

Whether any reading has ever corroborated this indicator.

created_at: Option<Timestamp>

Timestamp when the indicator was created.

updated_at: Option<Timestamp>

Timestamp when the indicator was last updated.

target: Option<f64>

The value the organization is aiming for, expressed in unit and read together with direction. Absent when no target has been set.

Targets live here rather than inside the objective’s wording, and they sit at the routine tier of change: revising a target is expected housekeeping, unlike rewriting the objective it serves.

Implementations

impl Indicator

pub fn direction(&self) -> IndicatorDirection

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

pub fn set_direction(&mut self, value: IndicatorDirection)

Sets direction to the provided enum value.

pub fn frequency(&self) -> IndicatorFrequency

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

pub fn set_frequency(&mut self, value: IndicatorFrequency)

Sets frequency to the provided enum value.

pub fn verification_state(&self) -> IndicatorVerificationState

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

pub fn set_verification_state(&mut self, value: IndicatorVerificationState)

Sets verification_state to the provided enum value.

pub fn target(&self) -> f64

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

Trait Implementations

impl Clone for Indicator

fn clone(&self) -> Indicator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Indicator

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

Formats the value using the given formatter.

impl Default for Indicator

fn default() -> Self

Returns the “default value” for a type.

impl Message for Indicator

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 Indicator

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Indicator