ucg 0.8.0

A configuration generation grammar.
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

// Copyright 2017 Jeremy Wall <jeremy@marzhillstudios.com>
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.

//! The traits used by the ucg compiler for converting Val intermediate format into the output formats..
use std::error::Error;
use std::io::Write;
use std::rc::Rc;
use std::result;

use crate::build::Val;

pub type ConvertResult = result::Result<(), Box<dyn Error>>;

pub type ImportResult = result::Result<Rc<Val>, Box<dyn Error>>;

/// The trait that Converters from Val to different output formats for the
/// final conversion stage of the ucg compiler.
pub trait Converter {
    fn convert(&self, vs: Rc<Val>, w: &mut dyn Write) -> ConvertResult;
    fn file_ext(&self) -> String;
    fn description(&self) -> String;
    fn help(&self) -> String;
}

pub trait Importer {
    fn import(&self, bytes: &[u8]) -> result::Result<Rc<Val>, Box<dyn Error>>;
}