apivolve_generator_api 0.1.1

Api for creating generators for Apivolve, an API evolution tool that helps keep your APIs backwards compatible yet clean.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

use crate::gen1::AcceptedFormat;
use crate::gen1::FunctionalityRequest;
use crate::gen1::Generator;
use crate::gen1::UserPreferences;

/// The data types T and U can be used to transfer data between steps,
/// in case you prefer that to mutating the api struct itself.
pub trait GeneratorProtocol<G: Generator, T, U> {
    fn accepts(&mut self) -> Result<(AcceptedFormat, T), String>;

    fn features(
        &mut self,
        user_pref: UserPreferences,
        data: T,
    ) -> Result<(FunctionalityRequest, U), String>;

    fn make_generator(self, data: U) -> Result<G, String>;
}

//TODO @mark: add a way to do warnings?