Enum AnnotationKind 

pub enum AnnotationKind {
    Constraint,
    Invariant,
    Rationale,
}

The canonical annotation taxonomy the product surfaces.

Constraint, Invariant, and Rationale are the three kinds of reasoning we keep alongside code. The lowercase serde names are the wire/storage vocabulary shared with proto and the web API.

Variants

Constraint

A rule the code must obey. Example: “empty scope must return NoScope”.

Invariant

A property that must hold across operations. Example: “state DAG is append-only”.

Rationale

Design decision + reasoning. Example: “thread resolution walks to LCA because…”.

Implementations

impl AnnotationKind

pub fn as_str(&self) -> &'static str

Trait Implementations

impl Clone for AnnotationKind

fn clone(&self) -> AnnotationKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AnnotationKind

impl Debug for AnnotationKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AnnotationKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AnnotationKind

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

Formats the value using the given formatter.

impl Eq for AnnotationKind

impl FromStr for AnnotationKind

type Err = ContextError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for AnnotationKind

fn eq(&self, other: &AnnotationKind) -> 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 AnnotationKind

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 AnnotationKind