specta 2.0.0-rc.21

Easily export your Rust types to other languages
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

use std::path::Path;

use crate::TypeCollection;

/// TODO
///
/// Warning: The structure of this trait is not final and may change in the future.
// TODO: Finish this
pub trait Language {
    /// TODO
    type Error: std::error::Error + From<std::io::Error>;

    /// TODO
    fn export(&self, type_map: &TypeCollection) -> Result<String, Self::Error>;

    /// TODO
    // TODO: Not sure I love this here but it's for Tauri Specta.
    // TODO: Really a formatter can support multiple languages so it would be nice if we don't need `specta_typescript::eslint`, `specta_jsdoc::eslint`, etc.
    fn format(&self, path: &Path) -> Result<(), Self::Error>;
}

impl<T: Language> Language for &T {
    type Error = T::Error;

    fn export(&self, type_map: &TypeCollection) -> Result<String, Self::Error> {
        (*self).export(type_map)
    }

    fn format(&self, path: &Path) -> Result<(), Self::Error> {
        (*self).format(path)
    }
}