gldf-rs 0.2.1

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
66
67
68
69
70
71

#![warn(missing_docs)]
#![warn(rustdoc::broken_intra_doc_links)]
use serde::{Serialize};
use serde::Deserialize;
use yaserde_derive::YaDeserialize;
use yaserde_derive::YaSerialize;

/// Represents a file entry.
///
/// The `File` struct models a file entry within the GLDF file, including attributes such as ID,
/// content type, and file name. It supports serialization and deserialization of XML data for
/// working with file entries.
#[derive(Default, Debug, Clone, PartialEq, YaDeserialize, YaSerialize, Serialize, Deserialize)]
pub struct File {
    /// The ID of the file.
    #[yaserde(attribute)]
    #[yaserde(rename = "id")]
    #[serde(rename = "@id")]
    pub id: String,

    /// The content type of the file.
    #[yaserde(attribute)]
    #[yaserde(rename = "contentType")]
    #[serde(rename = "@contentType")]
    pub content_type: String,

    /// The type of the file.
    #[yaserde(attribute)]
    #[yaserde(rename = "type")]
    #[serde(rename = "@type")]
    pub type_attr: String,

    /// The name of the file.
    #[yaserde(text)]
    #[serde(rename = "$")]
    pub file_name: String,
}

/// Represents a collection of file entries.
///
/// The `Files` struct models a collection of file entries within the GLDF file. It contains a list
/// of individual `File` instances. It supports serialization and deserialization of XML data for
/// working with file collections.
/// /// Example of how to construct a `Files` instance:
// ///
// /// ```
// /// use gldf_rs::gldf::{Files, File};
// ///
// /// let file_entries = Files {
// ///     file: vec![
// ///         File {
// ///             id: "file123".to_string(),
// ///             content_type: "image/jpeg".to_string(),
// ///             type_attr: "Thumbnail".to_string(),
// ///             file_name: "thumbnail.jpg".to_string(),
// ///         },
// ///         // ... (add more file entries as needed)
// ///     ],
// /// };
// /// ```
#[derive(Default, Debug, Clone, PartialEq, YaDeserialize, YaSerialize, Serialize, Deserialize)]
pub struct Files {
    /// The list of file entries.
    #[yaserde(child)]
    #[yaserde(rename = "File")]
    #[serde(rename = "File")]
    // a collection of files referenced in the GLDF file
    pub file: Vec<File>,
}