Enum BmopfSchemaVersion 

#[non_exhaustive]
pub enum BmopfSchemaVersion {
    Bmopf010,
    Bmopf020,
}

The BMOPF schema version a document is read as or written against.

A schema version fixes which element classes exist and where they live. 0.1.0 declares the ten element classes and four transformer subtypes the historical baseline contains, sets additionalProperties: false on every object, and permits free-form extras and meta.provenance; the classes outside it travel there. 0.2.0 declares those classes at the top level and gives the transformer taps, winding neutral impedance, and no load admittance their own slots. Unsupported malformed records still require diagnostics.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bmopf010

Schema 0.1.0, the historical baseline.

Bmopf020

Schema 0.2.0, the proposal in https://github.com/distribution-system-opt/dsopt-schema. The default output version, because it states every class the model carries.

Implementations

impl BmopfSchemaVersion

pub const fn version(self) -> &'static str

The schema version string, as meta.schema_version states it.

pub const fn schema_id(self) -> &'static str

The canonical $id of the schema document, independent of retrieval revision.

pub const fn retrieval_url(self) -> &'static str

Retrieval URL for the exact schema archived by PowerIO.

pub fn from_schema_id(id: &str) -> Option<Self>

The version a meta.$schema value names, or None when it names none.

A released schema document carries its version in its own $id, so the version is the directory the schema document sits in. Documents written before the schema moved to its own repository name the draft schema of the bmopf-report repository, which only ever held 0.1.0, so those locations resolve to 0.1.0 whatever shape they take. A location naming neither answers None rather than choosing a version.

Trait Implementations

impl Clone for BmopfSchemaVersion

fn clone(&self) -> BmopfSchemaVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BmopfSchemaVersion

impl Debug for BmopfSchemaVersion

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

Formats the value using the given formatter.

impl Default for BmopfSchemaVersion

fn default() -> BmopfSchemaVersion

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BmopfSchemaVersion

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BmopfSchemaVersion

impl JsonSchema for BmopfSchemaVersion

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 PartialEq for BmopfSchemaVersion

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

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 BmopfSchemaVersion