Struct Envelope 

pub struct Envelope {
    pub schema_ref: String,
    pub header: Header,
    pub message: Message,
    pub live: bool,
    pub version: Option<String>,
}

Top level EDDN message wrapper

Fields

schema_ref: String

header: Header

message: Message

live: bool

Whether this is the galaxy everyone is in

EDDN carries alpha and beta game data on the same socket as live data, separated only by a /test suffix on the $schemaRef. It parses like anything else and describes somewhere that is not the live galaxy, so recording it is a mistake rather than a choice.

Here rather than on Message, which says what a payload holds. This says where it came from, and the two are independent: a test message is still a journal message or a market message, and reads as one.

subscribe never yields an envelope with this false. It is on the type for whoever reads an envelope some other way.

version: Option<String>

Which version of its schema the sender wrote to, as the reference spells it

Nothing routes on this and nothing should: what the two live outfitting versions disagree about is one field of one payload, and is answered by reading either. It is here to be looked at. A sender still on an old version, or a version nothing here has heard of, does not announce itself any other way.

None only where the reference is not one EDDN sends, which is the same case that leaves a message Message::Unmodeled.

Trait Implementations

impl Debug for Envelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Envelope

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.