Struct ArticleEnvelope 

pub struct ArticleEnvelope {
    pub schema_version: String,
    pub payload: Value,
}

Schema version wrapper for forward compatibility.

Wraps API responses with schema version information. This allows applications to handle multiple schema versions and gracefully reject unsupported versions.

Usage

use wme_models::ArticleEnvelope;

// Check if version is supported
let envelope = ArticleEnvelope::new("2024.2", serde_json::json!({"name": "Test"}));
assert!(envelope.is_supported());

// Parse the payload
let data: serde_json::Value = envelope.parse().unwrap();

Fields

schema_version: String

Schema version (e.g., “2024.1”, “2024.2”)

payload: Value

Raw JSON payload

Implementations

impl ArticleEnvelope

pub fn new(schema_version: &str, payload: Value) -> Self

Create a new envelope with a specific schema version.

Arguments

• schema_version - The schema version string
• payload - The JSON payload to wrap

Example

use wme_models::ArticleEnvelope;

let envelope = ArticleEnvelope::new(
    "2024.2",
    serde_json::json!({"name": "Test"})
);

pub fn parse<T>(&self) -> Result<T, ModelError>

where T: for<'de> Deserialize<'de>,

Parse the payload into a typed struct.

Type Parameters

• T - The target type to deserialize into

Errors

Returns an error if:

• The schema version is unsupported
• Deserialization fails

Example

use wme_models::ArticleEnvelope;

let envelope = ArticleEnvelope::new(
    "2024.2",
    serde_json::json!({"name": "Test", "value": 42})
);

#[derive(serde::Deserialize)]
struct MyData { name: String, value: i32 }

let data: MyData = envelope.parse().unwrap();
assert_eq!(data.name, "Test");

pub fn schema_version(&self) -> &str

Get the schema version.

Example

use wme_models::ArticleEnvelope;

let envelope = ArticleEnvelope::new("2024.2", serde_json::json!({}));
assert_eq!(envelope.schema_version(), "2024.2");

pub fn is_supported(&self) -> bool

Check if this envelope can be parsed.

Returns true if the schema version is in the supported list.

Example

use wme_models::ArticleEnvelope;

let supported = ArticleEnvelope::new("2024.2", serde_json::json!({}));
assert!(supported.is_supported());

let unsupported = ArticleEnvelope::new("1999.1", serde_json::json!({}));
assert!(!unsupported.is_supported());

Trait Implementations

impl Clone for ArticleEnvelope

fn clone(&self) -> ArticleEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArticleEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ArticleEnvelope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ArticleEnvelope

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

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 ArticleEnvelope