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 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
#![doc(html_favicon_url = "https://raw.githubusercontent.com/zng-ui/zng/main/examples/image/res/zng-logo-icon.png")]
#![doc(html_logo_url = "https://raw.githubusercontent.com/zng-ui/zng/main/examples/image/res/zng-logo.png")]
//!
//! Config service and sources.
//!
//! # Crate
//!
#![doc = include_str!(concat!("../", std::env!("CARGO_PKG_README")))]
// suppress nag about very simple boxed closure signatures.
#![expect(clippy::type_complexity)]
#![warn(unused_extern_crates)]
#![warn(missing_docs)]
mod fallback;
pub use fallback::*;
mod json;
pub use json::*;
mod swap;
pub use swap::*;
mod switch;
pub use switch::*;
mod sync;
pub use sync::*;
#[cfg(feature = "toml")]
mod toml;
#[cfg(feature = "toml")]
pub use self::toml::*;
#[cfg(feature = "ron")]
mod ron;
#[cfg(feature = "ron")]
pub use self::ron::*;
#[cfg(feature = "yaml")]
mod yaml;
#[cfg(feature = "yaml")]
pub use self::yaml::*;
pub mod settings;
use std::{
any::Any,
collections::{hash_map, HashMap},
fmt, io,
sync::Arc,
};
use zng_app::{update::EventUpdate, view_process::raw_events::LOW_MEMORY_EVENT, AppExtension};
use zng_app_context::app_local;
use zng_clone_move::clmv;
use zng_ext_fs_watcher::{WatchFile, WatcherReadStatus, WatcherSyncStatus, WriteFile};
use zng_task as task;
use zng_txt::Txt;
use zng_var::{types::WeakArcVar, var, AnyVar, AnyWeakVar, ArcVar, BoxedVar, LocalVar, Var, VarHandles, VarModify, VarValue, WeakVar};
/// Application extension that provides mouse events and service.
///
/// # Services
///
/// Services this extension provides.
///
/// * [`CONFIG`]
#[derive(Default)]
pub struct ConfigManager {}
impl AppExtension for ConfigManager {
fn event_preview(&mut self, update: &mut EventUpdate) {
if LOW_MEMORY_EVENT.on(update).is_some() {
CONFIG_SV.write().low_memory();
}
}
}
/// Represents the app main config.
///
/// Config sources must be loaded using [`CONFIG.load`], otherwise the config only lives for the
/// duration of the app instance.
///
/// [`CONFIG.load`]: CONFIG::load
pub struct CONFIG;
impl CONFIG {
/// Replace the config source.
///
/// Variables and bindings survive source replacement, updating to the new value or setting the new source
/// if the key is not present in the new source.
pub fn load(&self, source: impl AnyConfig) {
CONFIG_SV.write().load(source)
}
/// Gets a read-only variable that represents the IO status of the config.
pub fn status(&self) -> BoxedVar<ConfigStatus> {
CONFIG_SV.read().status()
}
/// Wait until [`status`] is idle (not loading nor saving).
///
/// [`status`]: Self::status
pub async fn wait_idle(&self) {
task::yield_now().await; // in case a `load` request was just made
self.status().wait_value(|s| s.is_idle()).await;
}
/// Gets a variable that is bound to the config `key`.
///
/// The same variable is returned for multiple requests of the same key. If the loaded config is not read-only the
/// returned variable can be set to update the config source.
///
/// The `default` value is used if the key is not found in the config, the default value
/// is not inserted in the config, the key is inserted or replaced only when the returned variable updates.
pub fn get<T: ConfigValue>(&self, key: impl Into<ConfigKey>, default: T) -> BoxedVar<T> {
CONFIG_SV.write().get(key.into(), default, false)
}
/// Gets a variable that is bound to the config `key`, the `value` is set and if the `key` was not present it is also inserted on the config.
pub fn insert<T: ConfigValue>(&self, key: impl Into<ConfigKey>, value: T) -> BoxedVar<T> {
CONFIG_SV.write().get(key.into(), value, true)
}
}
impl AnyConfig for CONFIG {
fn get_raw(&mut self, key: ConfigKey, default: RawConfigValue, insert: bool, shared: bool) -> BoxedVar<RawConfigValue> {
CONFIG_SV.write().get_raw(key, default, insert, shared)
}
fn contains_key(&mut self, key: ConfigKey) -> BoxedVar<bool> {
CONFIG_SV.write().contains_key(key)
}
fn status(&self) -> BoxedVar<ConfigStatus> {
CONFIG.status()
}
fn remove(&mut self, key: &ConfigKey) -> bool {
CONFIG_SV.write().remove(key)
}
fn low_memory(&mut self) {
CONFIG_SV.write().low_memory()
}
}
impl Config for CONFIG {
fn get<T: ConfigValue>(&mut self, key: impl Into<ConfigKey>, default: T, insert: bool) -> BoxedVar<T> {
CONFIG_SV.write().get(key, default, insert)
}
}
app_local! {
static CONFIG_SV: SwapConfig = SwapConfig::new();
}
/// Unique key to a config entry.
pub type ConfigKey = Txt;
/// Marker trait for types that can stored in a [`Config`].
///
/// This trait is already implemented for types it applies.
#[diagnostic::on_unimplemented(note = "`ConfigValue` is implemented for all `T: VarValue + Serialize + DeserializeOwned`")]
pub trait ConfigValue: VarValue + serde::Serialize + serde::de::DeserializeOwned {}
impl<T: VarValue + serde::Serialize + serde::de::DeserializeOwned> ConfigValue for T {}
/// Represents any entry type in a config.
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct RawConfigValue(pub serde_json::Value);
impl RawConfigValue {
/// Serialize to the raw config format.
pub fn serialize<T: serde::Serialize>(value: T) -> Result<Self, serde_json::Error> {
serde_json::to_value(value).map(Self)
}
/// Deserialize from the raw config format.
pub fn deserialize<T: serde::de::DeserializeOwned>(self) -> Result<T, serde_json::Error> {
serde_json::from_value(self.0)
}
}
/// Represents a full config map in memory.
///
/// This can be used with [`SyncConfig`] to implement a full config.
pub trait ConfigMap: VarValue + fmt::Debug {
/// New empty map.
fn empty() -> Self;
/// Read a map from the file.
///
/// This method runs in unblocked context.
fn read(file: WatchFile) -> io::Result<Self>;
/// Write the map to a file.
///
/// This method runs in unblocked context.
fn write(self, file: &mut WriteFile) -> io::Result<()>;
/// Gets the weak typed value.
///
/// This method is used when `T` cannot be passed because the map is behind a dynamic reference,
/// the backend must convert the value from the in memory representation to [`RawConfigValue`].
///
/// This method can run in blocking contexts, work with in memory storage only.
fn get_raw(&self, key: &ConfigKey) -> Result<Option<RawConfigValue>, Arc<dyn std::error::Error + Send + Sync>>;
/// Sets the weak typed value.
///
/// This method is used when `T` cannot be passed because the map is behind a dynamic reference,
/// the backend must convert to the in memory representation.
///
/// If `map` is dereferenced mutable a write task will, if possible check if the entry already has the same value
/// before mutating the map to avoid a potentially expensive IO write.
///
/// This method can run in blocking contexts, work with in memory storage only.
fn set_raw(map: &mut VarModify<Self>, key: ConfigKey, value: RawConfigValue) -> Result<(), Arc<dyn std::error::Error + Send + Sync>>;
/// Returns if the key in config.
///
/// This method can run in blocking contexts, work with in memory storage only.
fn contains_key(&self, key: &ConfigKey) -> bool;
/// Remove the config entry associated with the key.
fn remove(map: &mut VarModify<Self>, key: &ConfigKey);
/// Get the value if present.
///
/// This method can run in blocking contexts, work with in memory storage only.
fn get<O: ConfigValue>(&self, key: &ConfigKey) -> Result<Option<O>, Arc<dyn std::error::Error + Send + Sync>> {
if let Some(value) = self.get_raw(key)? {
match RawConfigValue::deserialize(value) {
Ok(s) => Ok(Some(s)),
Err(e) => Err(Arc::new(e)),
}
} else {
Ok(None)
}
}
/// Set the value.
///
/// If possible check if the entry already has the same value before mutating the map to avoid a
/// potentially expensive clone operation. Note that the map will only be written if the map actually
/// changes, or an update is explicitly requested.
///
/// This method can run in blocking contexts, work with in memory storage only.
fn set<O: ConfigValue>(map: &mut VarModify<Self>, key: ConfigKey, value: O) -> Result<(), Arc<dyn std::error::Error + Send + Sync>> {
match RawConfigValue::serialize(value) {
Ok(s) => Self::set_raw(map, key, s),
Err(e) => Err(Arc::new(e)),
}
}
}
/// Represents one or more config sources behind a dynamic reference.
///
/// See [`Config`] for the full trait.
pub trait AnyConfig: Send + Any {
/// Gets a read-only variable that represents the IO status of the config.
fn status(&self) -> BoxedVar<ConfigStatus>;
/// Gets a weak typed variable to the config `key`.
///
/// This method is used when `T` cannot be passed because the config is behind a dynamic reference,
/// the backend must convert the value from the in memory representation to [`RawConfigValue`].
///
/// If `shared` is `true` and the key was already requested the same var is returned, if `false`
/// a new variable is always generated. Note that if you have two different variables for the same
/// key they will go out-of-sync as updates from setting one variable do not propagate to the other.
///
/// The `default` value is used if the key is not found in the config, the default value
/// is only inserted in the config if `insert`, otherwise the key is inserted or replaced only when the returned variable changes.
fn get_raw(&mut self, key: ConfigKey, default: RawConfigValue, insert: bool, shared: bool) -> BoxedVar<RawConfigValue>;
/// Gets a read-only variable that tracks if an entry for the `key` is in the backing storage.
fn contains_key(&mut self, key: ConfigKey) -> BoxedVar<bool>;
/// Removes the `key` from the backing storage.
///
/// Any active config variable for the key will continue to work normally, retaining the last config value and
/// re-inserting the key if assigned a new value.
///
/// Returns `true` if the key was found and will be removed in the next app update.
/// Returns `false` if the key was not found or the config is read-only.
fn remove(&mut self, key: &ConfigKey) -> bool;
/// Cleanup and flush RAM caches.
fn low_memory(&mut self);
}
impl dyn AnyConfig {
/// Get raw config and setup a bidi binding that converts to and from `T`.
///
/// See [`get_raw`](AnyConfig::get_raw) for more details about the inputs.
pub fn get_raw_serde_bidi<T: ConfigValue>(&mut self, key: impl Into<ConfigKey>, default: T, insert: bool, shared: bool) -> BoxedVar<T> {
let key = key.into();
let source_var = self.get_raw(
key.clone(),
RawConfigValue::serialize(&default).unwrap_or_else(|e| panic!("invalid default value, {e}")),
insert,
shared,
);
let var = var(RawConfigValue::deserialize(source_var.get()).unwrap_or(default));
source_var
.bind_filter_map_bidi(
&var,
// Raw -> T
clmv!(key, |raw| {
match RawConfigValue::deserialize(raw.clone()) {
Ok(value) => Some(value),
Err(e) => {
tracing::error!("get_raw_serde_bidi({key:?}) error, {e:?}");
None
}
}
}),
// T -> Raw
clmv!(key, source_var, |value| {
let _strong_ref = &source_var;
match RawConfigValue::serialize(value) {
Ok(raw) => Some(raw),
Err(e) => {
tracing::error!("get_raw_serde_bidi({key:?}) error, {e:?}");
None
}
}
}),
)
.perm();
var.boxed()
}
}
/// Represents one or more config sources.
pub trait Config: AnyConfig {
/// Gets a variable that is bound to the config `key`.
///
/// The same variable is returned for multiple requests of the same key. If the loaded config is not read-only the
/// returned variable can be set to update the config source.
///
/// The `default` value is used if the key is not found in the config, the default value
/// is only inserted in the config if `insert`, otherwise the key is inserted or replaced only when the returned variable changes.
fn get<T: ConfigValue>(&mut self, key: impl Into<ConfigKey>, default: T, insert: bool) -> BoxedVar<T>;
}
/// Config wrapper that only provides read-only variables from the inner config.
pub struct ReadOnlyConfig<C: Config> {
cfg: C,
}
impl<C: Config> ReadOnlyConfig<C> {
/// New reading from `cfg`.
pub fn new(cfg: C) -> Self {
Self { cfg }
}
}
impl<C: Config> AnyConfig for ReadOnlyConfig<C> {
fn get_raw(&mut self, key: ConfigKey, default: RawConfigValue, _: bool, shared: bool) -> BoxedVar<RawConfigValue> {
self.cfg.get_raw(key, default, false, shared).read_only()
}
fn contains_key(&mut self, key: ConfigKey) -> BoxedVar<bool> {
self.cfg.contains_key(key)
}
fn status(&self) -> BoxedVar<ConfigStatus> {
self.cfg.status()
}
fn remove(&mut self, _key: &ConfigKey) -> bool {
false
}
fn low_memory(&mut self) {
self.cfg.low_memory()
}
}
impl<C: Config> Config for ReadOnlyConfig<C> {
fn get<T: ConfigValue>(&mut self, key: impl Into<ConfigKey>, default: T, _: bool) -> BoxedVar<T> {
self.cfg.get(key.into(), default, false).read_only()
}
}
/// Memory only config.
///
/// Values are retained in memory even if all variables to the key are dropped, but they are lost when the process ends.
#[derive(Default)]
pub struct MemoryConfig {
values: HashMap<ConfigKey, ArcVar<RawConfigValue>>,
contains: HashMap<ConfigKey, WeakArcVar<bool>>,
}
impl AnyConfig for MemoryConfig {
fn status(&self) -> BoxedVar<ConfigStatus> {
LocalVar(ConfigStatus::Loaded).boxed()
}
fn get_raw(&mut self, key: ConfigKey, default: RawConfigValue, _insert: bool, _shared: bool) -> BoxedVar<RawConfigValue> {
match self.values.entry(key) {
hash_map::Entry::Occupied(e) => e.get().clone().boxed(),
hash_map::Entry::Vacant(e) => {
let r = var(default);
if let Some(v) = self.contains.get(e.key()) {
if let Some(v) = v.upgrade() {
v.set(true);
}
}
e.insert(r).clone().boxed()
}
}
}
fn contains_key(&mut self, key: ConfigKey) -> BoxedVar<bool> {
match self.contains.entry(key) {
hash_map::Entry::Occupied(mut e) => {
if let Some(r) = e.get().upgrade() {
r.boxed()
} else {
let r = var(self.values.contains_key(e.key()));
e.insert(r.downgrade());
r.boxed()
}
}
hash_map::Entry::Vacant(e) => {
let r = var(self.values.contains_key(e.key()));
e.insert(r.downgrade());
r.boxed()
}
}
}
fn remove(&mut self, key: &ConfigKey) -> bool {
if self.values.remove(key).is_some() {
self.contains.retain(|_, v| v.strong_count() > 0);
if let Some(v) = self.contains.get(key) {
if let Some(v) = v.upgrade() {
v.set(false);
}
}
true
} else {
false
}
}
fn low_memory(&mut self) {
self.contains.retain(|_, v| v.strong_count() > 0);
}
}
impl Config for MemoryConfig {
fn get<T: ConfigValue>(&mut self, key: impl Into<ConfigKey>, default: T, insert: bool) -> BoxedVar<T> {
self.get_raw(key.into(), RawConfigValue::serialize(default.clone()).unwrap(), insert, true)
.filter_map_bidi(
|m| m.clone().deserialize::<T>().ok(),
|v| RawConfigValue::serialize(v).ok(),
move || default.clone(),
)
.boxed()
}
}
struct ConfigVar<T: ConfigValue> {
var: WeakArcVar<T>,
binding: VarHandles,
}
impl<T: ConfigValue> ConfigVar<T> {
fn new_any(var: WeakArcVar<T>, binding: VarHandles) -> Box<dyn AnyConfigVar> {
Box::new(Self { var, binding })
}
}
struct ConfigContainsVar {
var: WeakArcVar<bool>,
binding: VarHandles,
}
/// Map of configs already bound to a variable.
///
/// The map only holds a weak reference to the variables.
#[derive(Default)]
pub struct ConfigVars {
values: HashMap<ConfigKey, Box<dyn AnyConfigVar>>,
contains: HashMap<ConfigKey, ConfigContainsVar>,
}
impl ConfigVars {
/// Gets the already bound variable or calls `bind` to generate a new binding.
pub fn get_or_bind<T: ConfigValue>(&mut self, key: ConfigKey, bind: impl FnOnce(&ConfigKey) -> BoxedVar<T>) -> BoxedVar<T> {
match self.values.entry(key) {
hash_map::Entry::Occupied(mut e) => {
if e.get().can_upgrade() {
if let Some(x) = e.get().as_any().downcast_ref::<ConfigVar<T>>() {
if let Some(var) = x.var.upgrade() {
return var.boxed();
}
} else {
tracing::error!(
"cannot get key `{}` as `{}` because it is already requested with a different type",
e.key(),
std::any::type_name::<T>()
);
return bind(e.key());
}
}
// cannot upgrade
let cfg = bind(e.key());
let res = var(cfg.get());
let binding = res.bind_map_bidi(
&cfg,
clmv!(cfg, |v| {
let _strong_ref = &cfg;
v.clone()
}),
Clone::clone,
);
e.insert(ConfigVar::new_any(res.downgrade(), binding));
res.boxed()
}
hash_map::Entry::Vacant(e) => {
let cfg = bind(e.key());
let res = var(cfg.get());
let binding = res.bind_map_bidi(
&cfg,
clmv!(cfg, |v| {
let _strong_ref = &cfg;
v.clone()
}),
Clone::clone,
);
e.insert(ConfigVar::new_any(res.downgrade(), binding));
res.boxed()
}
}
}
/// Bind the contains variable.
pub fn get_or_bind_contains(&mut self, key: ConfigKey, bind: impl FnOnce(&ConfigKey) -> BoxedVar<bool>) -> BoxedVar<bool> {
match self.contains.entry(key) {
hash_map::Entry::Occupied(mut e) => {
if let Some(res) = e.get().var.upgrade() {
return res.boxed();
}
let cfg = bind(e.key());
let res = var(cfg.get());
let binding = VarHandles(vec![
cfg.bind(&res),
res.hook_any(Box::new(move |_| {
let _strong_ref = &cfg;
true
})),
]);
e.insert(ConfigContainsVar {
var: res.downgrade(),
binding,
});
res.boxed()
}
hash_map::Entry::Vacant(e) => {
let cfg = bind(e.key());
let res = var(cfg.get());
let binding = VarHandles(vec![
cfg.bind(&res),
res.hook_any(Box::new(move |_| {
let _strong_ref = &cfg;
true
})),
]);
e.insert(ConfigContainsVar {
var: res.downgrade(),
binding,
});
res.boxed()
}
}
}
/// Bind all variables to the new `source`.
///
/// If the map entry is present in the `source` the variable is updated to the new value, if not the entry
/// is inserted in the source. The variable is then bound to the source.
pub fn rebind(&mut self, source: &mut dyn AnyConfig) {
self.values.retain(|key, wk_var| wk_var.rebind(key, source));
self.contains.retain(|key, wk_var| wk_var.rebind(key, source));
}
/// System warning low memory, flush caches.
pub fn low_memory(&mut self) {
self.values.retain(|_, v| v.can_upgrade());
self.contains.retain(|_, v| v.var.strong_count() > 0)
}
}
trait AnyConfigVar: Any + Send + Sync {
fn as_any(&self) -> &dyn Any;
fn can_upgrade(&self) -> bool;
fn rebind(&mut self, key: &ConfigKey, source: &mut dyn AnyConfig) -> bool;
}
impl<T: ConfigValue> AnyConfigVar for ConfigVar<T> {
fn as_any(&self) -> &dyn Any {
self
}
fn can_upgrade(&self) -> bool {
self.var.strong_count() > 0
}
fn rebind(&mut self, key: &ConfigKey, source: &mut dyn AnyConfig) -> bool {
let var = if let Some(var) = self.var.upgrade() {
var
} else {
// no need to retain, will bind directly to new source if requested later.
return false;
};
// get or insert the source var
let source_var = source.get_raw(key.clone(), RawConfigValue::serialize(var.get()).unwrap(), false, false);
// var.set_from_map(source_var)
var.modify(clmv!(source_var, key, |vm| {
match RawConfigValue::deserialize::<T>(source_var.get()) {
Ok(value) => {
vm.set(value);
}
Err(e) => {
// invalid data error
tracing::error!("rebind config get({key:?}) error, {e:?}");
// try to override
let _ = source_var.set(RawConfigValue::serialize(vm.as_ref()).unwrap());
}
}
}));
let mut first = true;
self.binding = source_var.bind_filter_map_bidi(
&var,
// Raw -> T
clmv!(key, |raw| {
match RawConfigValue::deserialize(raw.clone()) {
Ok(value) => Some(value),
Err(e) => {
tracing::error!("rebind config get({key:?}) error, {e:?}");
None
}
}
}),
// T -> Raw
clmv!(key, source_var, |value| {
if std::mem::take(&mut first) {
return None; // skip value we just set.
}
let _strong_ref = &source_var;
match RawConfigValue::serialize(value) {
Ok(raw) => Some(raw),
Err(e) => {
tracing::error!("rebind config set({key:?}) error, {e:?}");
None
}
}
}),
);
true
}
}
impl ConfigContainsVar {
fn rebind(&mut self, key: &ConfigKey, source: &mut dyn AnyConfig) -> bool {
if let Some(res) = self.var.upgrade() {
let cfg = source.contains_key(key.clone());
res.set_from(&cfg);
self.binding = VarHandles(vec![
cfg.bind(&res),
res.hook_any(Box::new(move |_| {
let _strong_ref = &cfg;
true
})),
]);
true
} else {
false
}
}
}
/// Represents the current IO status of the config.
#[derive(Debug, Clone)]
pub enum ConfigStatus {
/// Config is loaded.
Loaded,
/// Config is loading.
Loading,
/// Config is saving.
Saving,
/// Config last load failed.
LoadErrors(ConfigStatusError),
/// Config last save failed.
SaveErrors(ConfigStatusError),
}
impl ConfigStatus {
/// If status is not loading nor saving.
pub fn is_idle(&self) -> bool {
!matches!(self, Self::Loading | Self::Saving)
}
/// If status is load or save errors.
pub fn is_err(&self) -> bool {
matches!(self, ConfigStatus::LoadErrors(_) | ConfigStatus::SaveErrors(_))
}
/// Errors list.
///
/// Note that [`is_err`] may be true even when this is empty.
///
/// [`is_err`]: Self::is_err
pub fn errors(&self) -> &[Arc<dyn std::error::Error + Send + Sync>] {
match self {
ConfigStatus::LoadErrors(e) => e,
ConfigStatus::SaveErrors(e) => e,
_ => &[],
}
}
/// merge all `status`.
pub fn merge_status(status: impl Iterator<Item = ConfigStatus>) -> ConfigStatus {
let mut load_errors = vec![];
let mut save_errors = vec![];
let mut loading = false;
let mut saving = false;
for s in status {
match s {
ConfigStatus::Loaded => {}
ConfigStatus::Loading => loading = true,
ConfigStatus::Saving => saving = true,
ConfigStatus::LoadErrors(e) => {
if load_errors.is_empty() {
load_errors = e;
} else {
load_errors.extend(e);
}
}
ConfigStatus::SaveErrors(e) => {
if save_errors.is_empty() {
save_errors = e;
} else {
save_errors.extend(e);
}
}
}
}
if loading {
ConfigStatus::Loading
} else if saving {
ConfigStatus::Saving
} else if !load_errors.is_empty() {
ConfigStatus::LoadErrors(load_errors)
} else if !save_errors.is_empty() {
ConfigStatus::SaveErrors(save_errors)
} else {
ConfigStatus::Loaded
}
}
}
impl fmt::Display for ConfigStatus {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Loaded => Ok(()),
Self::Loading => write!(f, "loading…"),
Self::Saving => write!(f, "saving…"),
Self::LoadErrors(e) => {
writeln!(f, "read errors:")?;
for e in e {
writeln!(f, " {e}")?;
}
Ok(())
}
Self::SaveErrors(e) => {
writeln!(f, "write errors:")?;
for e in e {
writeln!(f, " {e}")?;
}
Ok(())
}
}
}
}
impl PartialEq for ConfigStatus {
fn eq(&self, other: &Self) -> bool {
match (self, other) {
(Self::LoadErrors(a), Self::LoadErrors(b)) => a.is_empty() && b.is_empty(),
(Self::SaveErrors(a), Self::SaveErrors(b)) => a.is_empty() && b.is_empty(),
_ => core::mem::discriminant(self) == core::mem::discriminant(other),
}
}
}
impl Eq for ConfigStatus {}
impl WatcherSyncStatus<ConfigStatusError, ConfigStatusError> for ConfigStatus {
fn writing() -> Self {
ConfigStatus::Saving
}
fn write_error(e: ConfigStatusError) -> Self {
ConfigStatus::SaveErrors(e)
}
}
impl WatcherReadStatus<ConfigStatusError> for ConfigStatus {
fn idle() -> Self {
ConfigStatus::Loaded
}
fn reading() -> Self {
ConfigStatus::Loading
}
fn read_error(e: ConfigStatusError) -> Self {
ConfigStatus::LoadErrors(e)
}
}
type ConfigStatusError = Vec<Arc<dyn std::error::Error + Send + Sync>>;