Enum Recognition 

pub enum Recognition {
    Definite,
    Plausible,
    No {
        reason: Option<String>,
    },
}

How strongly an engine claims a candidate model as its own (spec §2.5).

This is the whole vocabulary of the recognition contract. The foundation layer holds no section names and no format grammar — the judgement is authored entirely by the engine; this type only gives every engine the same three words to express it in.

Recognition answers “whose is this?”, never “can this run?”. A Definite verdict is not a promise that the model is well-formed: the owning engine’s parse may still reject it.

Variants

Definite

The bytes carry a marker belonging to this engine’s format and to no other.

Plausible

The bytes are shaped like this engine’s format but carry nothing distinguishing them from another engine claiming the same shape.

No

Not this engine’s — the format is unrecognised, or the bytes carry another format’s marker.

Fields

reason: Option<String>

Optional engine-authored text saying what the engine believes the file is instead, e.g. “this looks like a SWMM model”. Advisory: applications must behave identically without it.

Implementations

impl Recognition

pub fn claims(&self) -> bool

Whether this verdict is a claim at all (spec §2.5.1 consults definite before plausible, and ignores no entirely).

pub fn no() -> Self

A plain refusal carrying no explanation.

Trait Implementations

impl Clone for Recognition

fn clone(&self) -> Recognition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Recognition

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

Formats the value using the given formatter.

impl Eq for Recognition

impl PartialEq for Recognition

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Recognition

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 Recognition