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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
use crate::progress::StepShared;
use crate::{
messages::{MessageLevel, MessageRingBuffer},
progress::{key, Key, State, Step, Task, Value},
unit::Unit,
};
use dashmap::DashMap;
use parking_lot::Mutex;
use std::sync::atomic::Ordering;
use std::{ops::Deref, sync::Arc, time::SystemTime};
/// A `Tree` represents an element of the progress tree.
///
/// It can be used to set progress and send messages.
/// ```rust
/// let tree = prodash::Tree::new();
/// let mut progress = tree.add_child("task 1");
///
/// progress.init(Some(10), Some("elements".into()));
/// for p in 0..10 {
/// progress.set(p);
/// }
/// progress.done("great success");
/// let mut sub_progress = progress.add_child("sub-task 1");
/// sub_progress.init(None, None);
/// sub_progress.set(5);
/// sub_progress.fail("couldn't finish");
/// ```
#[derive(Debug)]
pub struct Item {
pub(crate) key: Key,
pub(crate) value: StepShared,
pub(crate) highest_child_id: key::Id,
pub(crate) tree: Arc<DashMap<Key, Task>>,
pub(crate) messages: Arc<Mutex<MessageRingBuffer>>,
}
impl Drop for Item {
fn drop(&mut self) {
self.tree.remove(&self.key);
}
}
impl Item {
/// Initialize the Item for receiving progress information.
///
/// If `max` is `Some(…)`, it will be treated as upper bound. When progress is [set(…)](./struct.Item.html#method.set)
/// it should not exceed the given maximum.
/// If `max` is `None`, the progress is unbounded. Use this if the amount of work cannot accurately
/// be determined.
///
/// If `unit` is `Some(…)`, it is used for display purposes only. It should be using the plural.
///
/// If this method is never called, this `Item` will serve as organizational unit, useful to add more structure
/// to the progress tree.
///
/// **Note** that this method can be called multiple times, changing the bounded-ness and unit at will.
pub fn init(&mut self, max: Option<usize>, unit: Option<Unit>) {
if let Some(mut r) = self.tree.get_mut(&self.key) {
r.value_mut().progress = Some(Value {
done_at: max,
unit,
step: Arc::clone(&self.value),
..Default::default()
})
};
}
fn alter_progress(&mut self, f: impl FnMut(&mut Value)) {
if let Some(mut r) = self.tree.get_mut(&self.key) {
// NOTE: since we wrap around, if there are more tasks than we can have IDs for,
// and if all these tasks are still alive, two progress trees may see the same ID
// when these go out of scope, they delete the key and the other tree will not find
// its value anymore. Besides, it's probably weird to see tasks changing their progress
// all the time…
r.value_mut().progress.as_mut().map(f);
};
}
/// Set the name of this task's progress to the given `name`.
pub fn set_name(&mut self, name: impl Into<String>) {
if let Some(mut r) = self.tree.get_mut(&self.key) {
r.value_mut().name = name.into();
};
}
/// Get the name of this task's progress
pub fn name(&self) -> Option<String> {
self.tree.get(&self.key).map(|r| r.value().name.to_owned())
}
/// Returns the current step, as controlled by `inc*(…)` calls
pub fn step(&self) -> Option<Step> {
self.value.load(Ordering::Relaxed).into()
}
/// Returns the maximum about of items we expect, as provided with the `init(…)` call
pub fn max(&self) -> Option<Step> {
self.tree
.get(&self.key)
.and_then(|r| r.value().progress.as_ref().and_then(|p| p.done_at))
}
/// Returns the (cloned) unit associated with this Progress
pub fn unit(&self) -> Option<Unit> {
self.tree
.get(&self.key)
.and_then(|r| r.value().progress.as_ref().and_then(|p| p.unit.clone()))
}
/// Set the current progress to the given `step`.
///
/// **Note**: that this call has no effect unless `init(…)` was called before.
pub fn set(&mut self, step: Step) {
self.value.store(step, Ordering::SeqCst);
}
/// Increment the current progress by the given `step`.
///
/// **Note**: that this call has no effect unless `init(…)` was called before.
pub fn inc_by(&mut self, step: Step) {
self.value.fetch_add(step, Ordering::SeqCst);
}
/// Increment the current progress by one.
///
/// **Note**: that this call has no effect unless `init(…)` was called before.
pub fn inc(&mut self) {
self.value.fetch_add(1, Ordering::SeqCst);
}
/// Call to indicate that progress cannot be indicated, and that the task cannot be interrupted.
/// Use this, as opposed to `halted(…)`, if a non-interruptable call is about to be made without support
/// for any progress indication.
///
/// If `eta` is `Some(…)`, it specifies the time at which this task is expected to
/// make progress again.
///
/// The halted-state is undone next time [`tree::Item::running(…)`][Item::running()] is called.
pub fn blocked(&mut self, reason: &'static str, eta: Option<SystemTime>) {
self.alter_progress(|p| p.state = State::Blocked(reason, eta));
}
/// Call to indicate that progress cannot be indicated, even though the task can be interrupted.
/// Use this, as opposed to `blocked(…)`, if an interruptable call is about to be made without support
/// for any progress indication.
///
/// If `eta` is `Some(…)`, it specifies the time at which this task is expected to
/// make progress again.
///
/// The halted-state is undone next time [`tree::Item::running(…)`][Item::running()] is called.
pub fn halted(&mut self, reason: &'static str, eta: Option<SystemTime>) {
self.alter_progress(|p| p.state = State::Halted(reason, eta));
}
/// Call to indicate that progress is back in running state, which should be called after the reason for
/// calling `blocked()` or `halted()` as passed.
pub fn running(&mut self, reason: &'static str, eta: Option<SystemTime>) {
self.alter_progress(|p| p.state = State::Halted(reason, eta));
}
/// Adds a new child `Tree`, whose parent is this instance, with the given `name`.
///
/// **Important**: The depth of the hierarchy is limited to [`tree::Key::max_level`](./struct.Key.html#method.max_level).
/// Exceeding the level will be ignored, and new tasks will be added to this instance's
/// level instead.
pub fn add_child(&mut self, name: impl Into<String>) -> Item {
let child_key = self.key.add_child(self.highest_child_id);
self.tree.insert(
child_key,
Task {
name: name.into(),
progress: None,
},
);
self.highest_child_id = self.highest_child_id.wrapping_add(1);
Item {
highest_child_id: 0,
value: Default::default(),
key: child_key,
tree: self.tree.clone(),
messages: self.messages.clone(),
}
}
/// Create a `message` of the given `level` and store it with the progress tree.
///
/// Use this to provide additional,human-readable information about the progress
/// made, including indicating success or failure.
pub fn message(&mut self, level: MessageLevel, message: impl Into<String>) {
let message: String = message.into();
self.messages.lock().push_overwrite(
level,
{
let name = self.tree.get(&self.key).map(|v| v.name.to_owned()).unwrap_or_default();
#[cfg(feature = "progress-tree-log")]
match level {
MessageLevel::Failure => crate::warn!("{} → {}", name, message),
MessageLevel::Info | MessageLevel::Success => crate::info!("{} → {}", name, message),
};
name
},
message,
)
}
/// Create a message indicating the task is done
pub fn done(&mut self, message: impl Into<String>) {
self.message(MessageLevel::Success, message)
}
/// Create a message indicating the task failed
pub fn fail(&mut self, message: impl Into<String>) {
self.message(MessageLevel::Failure, message)
}
/// Create a message providing additional information about the progress thus far.
pub fn info(&mut self, message: impl Into<String>) {
self.message(MessageLevel::Info, message)
}
pub(crate) fn deep_clone(&self) -> Item {
Item {
key: self.key,
value: Default::default(),
highest_child_id: self.highest_child_id,
tree: Arc::new(self.tree.deref().clone()),
messages: Arc::new(Mutex::new(self.messages.lock().clone())),
}
}
}
impl crate::Progress for Item {
type SubProgress = Item;
fn add_child(&mut self, name: impl Into<String>) -> Self::SubProgress {
Item::add_child(self, name)
}
fn init(&mut self, max: Option<Step>, unit: Option<Unit>) {
Item::init(self, max, unit)
}
fn set(&mut self, step: usize) {
Item::set(self, step)
}
fn unit(&self) -> Option<Unit> {
Item::unit(self)
}
fn max(&self) -> Option<usize> {
Item::max(self)
}
fn step(&self) -> usize {
Item::step(self).unwrap_or(0)
}
fn inc_by(&mut self, step: usize) {
self.inc_by(step)
}
fn set_name(&mut self, name: impl Into<String>) {
Item::set_name(self, name)
}
fn name(&self) -> Option<String> {
Item::name(self)
}
fn message(&mut self, level: MessageLevel, message: impl Into<String>) {
Item::message(self, level, message)
}
}