sora-export 0.3.0

Simple and powerful configuration table compiler for games and data-heavy tools.
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

use std::path::PathBuf;

use sora_data::localization::LocaleCatalog;
use sora_data::model::ConfigData;
use sora_diagnostics::Result;
use sora_execution::ExecutionContext;
use sora_ir::model::ConfigIr;

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ExportOutput {
    Directory(PathBuf),
    File(PathBuf),
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum OutputKind {
    Directory,
    File,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum ExportCompression {
    #[default]
    None,
    Zstd {
        level: i32,
    },
}

#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub struct ExportOptions {
    pub compression: ExportCompression,
    pub locale: Option<String>,
}

pub struct ExportRequest<'a> {
    pub ir: &'a ConfigIr,
    pub data: &'a ConfigData,
    pub locale_catalog: Option<&'a LocaleCatalog>,
    pub execution: &'a ExecutionContext,
    pub options: ExportOptions,
    pub output: ExportOutput,
}

pub trait DataExporter: Send + Sync {
    fn format_name(&self) -> &'static str;
    fn output_kind(&self) -> OutputKind;
    fn export(&self, request: ExportRequest<'_>) -> Result<()>;
}