gldf-rs 0.3.0

GLDF (General Lighting Data Format) parser and writer for Rust, specifically for the Rust/WASM target as such designed for JSON format
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

#![warn(missing_docs)]
#![warn(rustdoc::broken_intra_doc_links)]
#![allow(non_local_definitions)]

/// The gldf header module (src/gldf/header.rs)
pub mod header;
pub use header::*;

/// The gldf general definitions module (src/gldf/general_definitions.rs)
pub mod general_definitions;

/// The gldf product definitions module (src/gldf/product_definitions.rs)
pub mod product_definitions;

/// The gldf meta information module (src/gldf/meta_information.rs)
/// not strictly needed but it is used in the gldf-sign
pub mod meta_information;

use serde::{Deserialize, Serialize};
pub use general_definitions::*;
pub use product_definitions::*;

fn get_xsnonamespaceschemalocation() -> String {
    "https://gldf.io/xsd/gldf/1.0.0-rc.1/gldf.xsd".to_string()
}

fn get_xmlns_xsi() -> String {
    "http://www.w3.org/2001/XMLSchema-instance".to_string()
}

/// Represents a GLDF (Global Lighting Data Format) product.
///
/// GLDFProduct is a Rust struct that models a product in the Global Lighting Data Format (GLDF).
/// It provides serialization and deserialization methods for working with GLDF XML data.
///
/// This struct is intended to represent GLDF products conforming to the schema specified at
/// `<https://gldf.io/xsd/gldf/1.0.0-rc.1/gldf.xsd.>`
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename = "Root")]
pub struct GldfProduct {
    /// This field is not serialized or deserialized but can be used to store the path to the
    /// GLDF product file.
    #[serde(skip)]
    pub path: String,

    /// The XML namespace for xsi (XML Schema Instance).
    #[serde(rename = "@xmlns:xsi", default = "get_xmlns_xsi")]
    pub xmlns_xsi: String,

    /// The xsi:noNamespaceSchemaLocation attribute specifying the schema location.
    #[serde(rename = "@xsi:noNamespaceSchemaLocation", default = "get_xsnonamespaceschemalocation")]
    pub xsnonamespaceschemalocation: String,

    /// The header of the GLDF product.
    #[serde(rename = "Header")]
    pub header: Header,

    /// The general definitions section of the GLDF product.
    #[serde(rename = "GeneralDefinitions")]
    pub general_definitions: GeneralDefinitions,

    /// The product definitions section of the GLDF product.
    #[serde(rename = "ProductDefinitions")]
    pub product_definitions: ProductDefinitions,
}