joat_logger/ui.rs
1// Copyright (c) 2023 Richard Cook
2//
3// Permission is hereby granted, free of charge, to any person obtaining
4// a copy of this software and associated documentation files (the
5// "Software"), to deal in the Software without restriction, including
6// without limitation the rights to use, copy, modify, merge, publish,
7// distribute, sublicense, and/or sell copies of the Software, and to
8// permit persons to whom the Software is furnished to do so, subject to
9// the following conditions:
10//
11// The above copyright notice and this permission notice shall be
12// included in all copies or substantial portions of the Software.
13//
14// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21//
22use crate::error::Error;
23use crate::logger::Logger;
24use crate::op::Op;
25use crate::op::OpProgress;
26use crate::result::Result;
27use crate::state::State;
28use log::set_boxed_logger;
29use std::sync::Arc;
30
31pub struct Ui {
32 state: Arc<State>,
33}
34
35impl Ui {
36 #[allow(unused)]
37 pub fn new(enable_logger: bool) -> Result<Self> {
38 let state = Arc::new(State::new());
39
40 if enable_logger {
41 set_boxed_logger(Box::new(Logger::new(Arc::clone(&state))))
42 .map_err(|_| Error::CouldNotSetLogger)?;
43 }
44
45 Ok(Self { state })
46 }
47
48 #[allow(unused)]
49 pub fn begin_operation(&self, len: Option<OpProgress>) -> Result<Op> {
50 Ok(Op::new(
51 Arc::clone(&self.state),
52 self.state.make_indicator(len)?,
53 ))
54 }
55
56 #[allow(unused)]
57 pub fn print(&self, msg: &str) {
58 self.state.print(msg)
59 }
60}