Enum MarkerKind 

pub enum MarkerKind {
    Contract {
        description: String,
        source: ContractSource,
    },
    Hazard {
        description: String,
    },
    Dependency {
        target_file: String,
        target_anchor: String,
        assumption: String,
    },
    Unstable {
        description: String,
        revisit_when: String,
    },
    Security {
        description: String,
    },
    Performance {
        description: String,
    },
    Deprecated {
        description: String,
        replacement: Option<String>,
    },
    TechDebt {
        description: String,
    },
    TestCoverage {
        description: String,
    },
}

Variants

Contract

Behavioral contract: invariant, precondition, assumption.

Fields

description: String

source: ContractSource

Hazard

Something non-obvious that could cause bugs.

Fields

description: String

Dependency

This code assumes something about code elsewhere.

Fields

target_file: String

target_anchor: String

assumption: String

Unstable

This code is provisional/experimental.

Fields

description: String

revisit_when: String

Security

Security-sensitive code: auth, crypto, input validation, etc.

Fields

description: String

Performance

Performance-sensitive code: hot paths, allocations, latency.

Fields

description: String

Deprecated

Deprecated code with optional replacement pointer.

Fields

description: String

replacement: Option<String>

TechDebt

Known technical debt to address later.

Fields

description: String

TestCoverage

Test coverage note: what’s tested, what’s missing.

Fields

description: String

Trait Implementations

impl Clone for MarkerKind

fn clone(&self) -> MarkerKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkerKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MarkerKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for MarkerKind

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for MarkerKind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.