install_framework/lib.rs
1// Copyright 2021 Yuri6037
2
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"),
5// to deal in the Software without restriction, including without limitation
6// the rights to use, copy, modify, merge, publish, distribute, sublicense,
7// and/or sell copies of the Software, and to permit persons to whom the
8// Software is furnished to do so, subject to the following conditions:
9
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
19// IN THE SOFTWARE.
20
21pub use install_framework_base as base;
22pub use install_framework_core as core;
23
24/// The unified run system. This function automatically causes the program to terminate with the proper exit code.
25/// This is the easiest way to run the installer framework
26///
27/// # Arguments
28///
29/// * `builder` - the builder to run
30#[cfg(feature = "cli")]
31pub fn run<'a>(builder: core::builder::InstallerBuilder<'a>)
32{
33 use install_framework_cli::CliInterface;
34 core::run::<CliInterface>(builder);
35}
36
37/// The unified run system. This function automatically causes the program to terminate with the proper exit code.
38/// This is the easiest way to run the installer framework
39///
40/// # Arguments
41///
42/// * `builder` - the builder to run
43#[cfg(feature = "gui")]
44pub fn run<'a>(builder: core::builder::InstallerBuilder<'a>)
45{
46 use install_framework_gui::GuiInterface;
47 core::run::<GuiInterface>(builder);
48}
49
50/// The unified run system. This function automatically causes the program to terminate with the proper exit code.
51/// This is the easiest way to run the installer framework
52///
53/// # Arguments
54///
55/// * `builder` - the builder to run
56#[cfg(not(any(feature = "gui", feature = "cli")))]
57pub fn run<'a>(_: core::builder::InstallerBuilder<'a>)
58{
59 panic!("This crate is not supposed to be used without any interfaces!");
60}