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 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
#![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")]
//! App execution context.
//!
//! # Crate
//!
#![doc = include_str!(concat!("../", std::env!("CARGO_PKG_README")))]
#![warn(unused_extern_crates)]
#![warn(missing_docs)]
use std::{any::Any, cell::RefCell, fmt, mem, ops, sync::Arc, thread::LocalKey, time::Duration};
use parking_lot::*;
use zng_txt::Txt;
use zng_unique_id::unique_id_32;
#[doc(hidden)]
pub use zng_unique_id::{hot_static, hot_static_ref};
unique_id_32! {
/// Identifies an app instance.
pub struct AppId;
}
zng_unique_id::impl_unique_id_name!(AppId);
zng_unique_id::impl_unique_id_fmt!(AppId);
zng_unique_id::impl_unique_id_bytemuck!(AppId);
impl serde::Serialize for AppId {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
let name = self.name();
if name.is_empty() {
use serde::ser::Error;
return Err(S::Error::custom("cannot serialize unnamed `AppId`"));
}
name.serialize(serializer)
}
}
impl<'de> serde::Deserialize<'de> for AppId {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
let name = Txt::deserialize(deserializer)?;
Ok(AppId::named(name))
}
}
#[derive(Clone, Copy)]
enum LocalValueKind {
Local,
Var,
App,
}
impl LocalValueKind {
/// Include in local captures.
fn include_local(self) -> bool {
!matches!(self, Self::Var)
}
/// Include in var captures.
fn include_var(self) -> bool {
!matches!(self, Self::Local)
}
}
/// `(value, is_context_var)`
type LocalValue = (Arc<dyn Any + Send + Sync>, LocalValueKind);
// equivalent to rustc_hash::FxHashMap, but can be constructed in `const`.
type LocalData = hashbrown::HashMap<AppLocalId, LocalValue, BuildFxHasher>;
#[derive(Clone, Default)]
struct BuildFxHasher;
impl std::hash::BuildHasher for BuildFxHasher {
type Hasher = rustc_hash::FxHasher;
fn build_hasher(&self) -> Self::Hasher {
rustc_hash::FxHasher::default()
}
}
const fn new_local_data() -> LocalData {
hashbrown::HashMap::with_hasher(BuildFxHasher)
}
type LocalSet = hashbrown::HashSet<AppLocalId, BuildFxHasher>;
const fn new_local_set() -> LocalSet {
hashbrown::HashSet::with_hasher(BuildFxHasher)
}
/// Represents an app lifetime, ends the app on drop.
///
/// You can use [`LocalContext::start_app`] to manually create an app scope without actually running an app.
#[must_use = "ends the app scope on drop"]
pub struct AppScope {
id: AppId,
_same_thread: std::rc::Rc<()>,
}
impl Drop for AppScope {
fn drop(&mut self) {
LocalContext::end_app(self.id);
}
}
impl AppId {
fn local_id() -> AppLocalId {
hot_static! {
static ID: u8 = 0;
}
AppLocalId(hot_static_ref!(ID) as *const u8 as *const () as _)
}
}
fn cleanup_list_id() -> AppLocalId {
hot_static! {
static ID: u8 = 0;
}
AppLocalId(hot_static_ref!(ID) as *const u8 as *const () as _)
}
/// Tracks the current execution context.
///
/// The context tracks the current app, all or some [`context_local!`] and [`TracingDispatcherContext`].
#[derive(Clone)]
pub struct LocalContext {
data: LocalData,
tracing: Option<tracing::dispatcher::Dispatch>,
}
impl fmt::Debug for LocalContext {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let app = self
.data
.get(&AppId::local_id())
.map(|(v, _)| v.downcast_ref::<AppId>().unwrap())
.copied();
f.debug_struct("LocalContext")
.field("<app>", &app)
.field("<entries>", &(self.data.len() - 1))
.finish()
}
}
impl Default for LocalContext {
fn default() -> Self {
Self::new()
}
}
impl LocalContext {
/// New empty context.
pub const fn new() -> Self {
Self {
data: new_local_data(),
tracing: None,
}
}
/// Start an app scope in the current thread.
pub fn start_app(id: AppId) -> AppScope {
let valid = LOCAL.with_borrow_mut_dyn(|c| match c.entry(AppId::local_id()) {
hashbrown::hash_map::Entry::Occupied(_) => false,
hashbrown::hash_map::Entry::Vacant(e) => {
e.insert((Arc::new(id), LocalValueKind::App));
true
}
});
assert!(valid, "cannot start app, another app is already in the thread context");
AppScope {
id,
_same_thread: std::rc::Rc::new(()),
}
}
fn end_app(id: AppId) {
let valid = LOCAL.with_borrow_mut_dyn(|c| {
if c.get(&AppId::local_id())
.map(|(v, _)| v.downcast_ref::<AppId>() == Some(&id))
.unwrap_or(false)
{
Some(mem::take(&mut *c))
} else {
None
}
});
if let Some(data) = valid {
// SAFETY: app resources may leak, but we terminate the process
let r = std::panic::catch_unwind(std::panic::AssertUnwindSafe(move || {
drop(data); // deinit
}));
if let Err(p) = r {
tracing::error!("panic on app drop. {}", panic_str(&p));
eprintln!("panic on app drop. {}", panic_str(&p));
zng_env::exit(i32::from_le_bytes(*b"appa"));
}
} else {
tracing::error!("can only drop app in one of its threads");
eprintln!("can only drop app in one of its threads");
zng_env::exit(i32::from_le_bytes(*b"appa"));
}
}
/// Get the ID of the app that owns the current context.
pub fn current_app() -> Option<AppId> {
LOCAL.with_borrow_dyn(|c| c.get(&AppId::local_id()).map(|(v, _)| v.downcast_ref::<AppId>().unwrap()).copied())
}
/// Register to run when the app deinits and all clones of the app context are dropped.
pub fn register_cleanup(cleanup: impl FnOnce(AppId) + Send + 'static) {
let id = Self::current_app().expect("no app in context");
Self::register_cleanup_dyn(Box::new(move || cleanup(id)));
}
fn register_cleanup_dyn(cleanup: Box<dyn FnOnce() + Send>) {
let cleanup = RunOnDrop::new(cleanup);
type CleanupList = Vec<RunOnDrop<Box<dyn FnOnce() + Send>>>;
LOCAL.with_borrow_mut_dyn(|c| {
let c = c
.entry(cleanup_list_id())
.or_insert_with(|| (Arc::new(Mutex::new(CleanupList::new())), LocalValueKind::App));
c.0.downcast_ref::<Mutex<CleanupList>>().unwrap().lock().push(cleanup);
});
}
/// Capture a snapshot of the current context that can be restored in another thread to recreate
/// the current context.
///
/// Context locals modified after this capture are not included in the capture.
///
/// This is equivalent to [``CaptureFilter::All`].
pub fn capture() -> Self {
Self {
data: LOCAL.with_borrow_dyn(|c| c.clone()),
tracing: Some(tracing::dispatcher::get_default(|d| d.clone())),
}
}
/// Capture a snapshot of the current context that only includes `filter`.
pub fn capture_filtered(filter: CaptureFilter) -> Self {
match filter {
CaptureFilter::None => Self::new(),
CaptureFilter::All => Self::capture(),
CaptureFilter::ContextVars { exclude } => {
let mut data = new_local_data();
LOCAL.with_borrow_dyn(|c| {
for (k, (v, kind)) in c.iter() {
if kind.include_var() && !exclude.0.contains(k) {
data.insert(*k, (v.clone(), *kind));
}
}
});
Self { data, tracing: None }
}
CaptureFilter::ContextLocals { exclude } => {
let mut data = new_local_data();
LOCAL.with_borrow_dyn(|c| {
for (k, (v, kind)) in c.iter() {
if kind.include_local() && !exclude.0.contains(k) {
data.insert(*k, (v.clone(), *kind));
}
}
});
Self {
data,
tracing: Some(tracing::dispatcher::get_default(|d| d.clone())),
}
}
CaptureFilter::Include(set) => {
let mut data = new_local_data();
LOCAL.with_borrow_dyn(|c| {
for (k, v) in c.iter() {
if set.0.contains(k) {
data.insert(*k, v.clone());
}
}
});
Self {
data,
tracing: if set.contains(&TracingDispatcherContext) {
Some(tracing::dispatcher::get_default(|d| d.clone()))
} else {
None
},
}
}
CaptureFilter::Exclude(set) => {
let mut data = new_local_data();
LOCAL.with_borrow_dyn(|c| {
for (k, v) in c.iter() {
if !set.0.contains(k) {
data.insert(*k, v.clone());
}
}
});
Self {
data,
tracing: if !set.contains(&TracingDispatcherContext) {
Some(tracing::dispatcher::get_default(|d| d.clone()))
} else {
None
},
}
}
}
}
/// Collects a set of all the values in the context.
pub fn value_set(&self) -> ContextValueSet {
let mut set = ContextValueSet::new();
LOCAL.with_borrow_dyn(|c| {
for k in c.keys() {
set.0.insert(*k);
}
});
set
}
/// Calls `f` in the captured context.
///
/// Note that this fully replaces the parent context for the duration of the `f` call, see [`with_context_blend`]
/// for a blending alternative.
///
/// [`with_context_blend`]: Self::with_context_blend
pub fn with_context<R>(&mut self, f: impl FnOnce() -> R) -> R {
let data = mem::take(&mut self.data);
let prev = LOCAL.with_borrow_mut_dyn(|c| mem::replace(c, data));
let _tracing_restore = self.tracing.as_ref().map(tracing::dispatcher::set_default);
let _restore = RunOnDrop::new(|| {
self.data = LOCAL.with_borrow_mut_dyn(|c| mem::replace(c, prev));
});
f()
}
/// Calls `f` while all contextual values of `self` are set on the parent context.
///
/// Unlike [`with_context`] this does not remove values that are only set in the parent context, the
/// downside is that this call is more expensive.
///
/// If `over` is `true` all the values of `self` are set over the parent values, if `false` only
/// the values not already set in the parent are set.
///
/// [`with_context`]: Self::with_context
pub fn with_context_blend<R>(&mut self, over: bool, f: impl FnOnce() -> R) -> R {
if self.data.is_empty() {
f()
} else {
let prev = LOCAL.with_borrow_mut_dyn(|c| {
let (mut base, over) = if over { (c.clone(), &self.data) } else { (self.data.clone(), &*c) };
for (k, v) in over {
base.insert(*k, v.clone());
}
mem::replace(c, base)
});
let _restore = RunOnDrop::new(|| {
LOCAL.with_borrow_mut_dyn(|c| {
*c = prev;
});
});
f()
}
}
/// Blend `ctx` over `self`.
pub fn extend(&mut self, ctx: Self) {
self.data.extend(ctx.data);
}
fn contains(key: AppLocalId) -> bool {
LOCAL.with_borrow_dyn(|c| c.contains_key(&key))
}
fn get(key: AppLocalId) -> Option<LocalValue> {
LOCAL.with_borrow_dyn(|c| c.get(&key).cloned())
}
fn set(key: AppLocalId, value: LocalValue) -> Option<LocalValue> {
LOCAL.with_borrow_mut_dyn(|c| c.insert(key, value))
}
fn remove(key: AppLocalId) -> Option<LocalValue> {
LOCAL.with_borrow_mut_dyn(|c| c.remove(&key))
}
fn with_value_ctx<T: Send + Sync + 'static>(
key: &'static ContextLocal<T>,
kind: LocalValueKind,
value: &mut Option<Arc<T>>,
f: impl FnOnce(),
) {
let key = key.id();
let prev = Self::set(key, (value.take().expect("no `value` to set"), kind));
let _restore = RunOnDrop::new(move || {
let back = if let Some(prev) = prev {
Self::set(key, prev)
} else {
Self::remove(key)
}
.unwrap();
*value = Some(Arc::downcast(back.0).unwrap());
});
f();
}
fn with_default_ctx<T: Send + Sync + 'static>(key: &'static ContextLocal<T>, f: impl FnOnce()) {
let key = key.id();
let prev = Self::remove(key);
let _restore = RunOnDrop::new(move || {
if let Some(prev) = prev {
Self::set(key, prev);
}
});
f()
}
}
thread_local! {
static LOCAL: RefCell<LocalData> = const { RefCell::new(new_local_data()) };
}
trait LocalKeyDyn {
fn with_borrow_dyn<R>(&'static self, f: impl FnOnce(&LocalData) -> R) -> R;
fn with_borrow_mut_dyn<R>(&'static self, f: impl FnOnce(&mut LocalData) -> R) -> R;
}
impl LocalKeyDyn for LocalKey<RefCell<LocalData>> {
fn with_borrow_dyn<R>(&'static self, f: impl FnOnce(&LocalData) -> R) -> R {
let mut r = None;
let f = |l: &LocalData| r = Some(f(l));
#[cfg(feature = "dyn_closure")]
let f: Box<dyn FnOnce(&LocalData)> = Box::new(f);
self.with_borrow(f);
r.unwrap()
}
fn with_borrow_mut_dyn<R>(&'static self, f: impl FnOnce(&mut LocalData) -> R) -> R {
let mut r = None;
let f = |l: &mut LocalData| r = Some(f(l));
#[cfg(feature = "dyn_closure")]
let f: Box<dyn FnOnce(&mut LocalData)> = Box::new(f);
self.with_borrow_mut(f);
r.unwrap()
}
}
/*
app_local!
*/
#[doc(hidden)]
pub struct AppLocalConst<T: Send + Sync + 'static> {
value: RwLock<T>,
}
impl<T: Send + Sync + 'static> AppLocalConst<T> {
pub const fn new(init: T) -> Self {
Self { value: RwLock::new(init) }
}
}
#[doc(hidden)]
pub struct AppLocalOption<T: Send + Sync + 'static> {
value: RwLock<Option<T>>,
init: fn() -> T,
}
impl<T: Send + Sync + 'static> AppLocalOption<T> {
pub const fn new(init: fn() -> T) -> Self {
Self {
value: RwLock::new(None),
init,
}
}
fn read_impl(&'static self, read: RwLockReadGuard<'static, Option<T>>) -> MappedRwLockReadGuard<'static, T> {
if read.is_some() {
return RwLockReadGuard::map(read, |v| v.as_ref().unwrap());
}
drop(read);
let mut write = self.value.write();
if write.is_some() {
drop(write);
return self.read();
}
let value = (self.init)();
*write = Some(value);
let read = RwLockWriteGuard::downgrade(write);
RwLockReadGuard::map(read, |v| v.as_ref().unwrap())
}
fn write_impl(&'static self, mut write: RwLockWriteGuard<'static, Option<T>>) -> MappedRwLockWriteGuard<'static, T> {
if write.is_some() {
return RwLockWriteGuard::map(write, |v| v.as_mut().unwrap());
}
let value = (self.init)();
*write = Some(value);
RwLockWriteGuard::map(write, |v| v.as_mut().unwrap())
}
}
#[doc(hidden)]
pub struct AppLocalVec<T: Send + Sync + 'static> {
value: RwLock<Vec<(AppId, T)>>,
init: fn() -> T,
}
impl<T: Send + Sync + 'static> AppLocalVec<T> {
pub const fn new(init: fn() -> T) -> Self {
Self {
value: RwLock::new(vec![]),
init,
}
}
fn cleanup(&'static self, id: AppId) {
self.try_cleanup(id, 0);
}
fn try_cleanup(&'static self, id: AppId, tries: u8) {
if let Some(mut w) = self.value.try_write_for(if tries == 0 {
Duration::from_millis(50)
} else {
Duration::from_millis(500)
}) {
if let Some(i) = w.iter().position(|(s, _)| *s == id) {
w.swap_remove(i);
}
} else if tries > 5 {
tracing::error!("failed to cleanup `app_local` for {id:?}, was locked after app drop");
} else {
std::thread::spawn(move || {
self.try_cleanup(id, tries + 1);
});
}
}
fn read_impl(&'static self, read: RwLockReadGuard<'static, Vec<(AppId, T)>>) -> MappedRwLockReadGuard<'static, T> {
let id = LocalContext::current_app().expect("no app running, `app_local` can only be accessed inside apps");
if let Some(i) = read.iter().position(|(s, _)| *s == id) {
return RwLockReadGuard::map(read, |v| &v[i].1);
}
drop(read);
let mut write = self.value.write();
if write.iter().any(|(s, _)| *s == id) {
drop(write);
return self.read();
}
let value = (self.init)();
let i = write.len();
write.push((id, value));
LocalContext::register_cleanup(Box::new(move |id| self.cleanup(id)));
let read = RwLockWriteGuard::downgrade(write);
RwLockReadGuard::map(read, |v| &v[i].1)
}
fn write_impl(&'static self, mut write: RwLockWriteGuard<'static, Vec<(AppId, T)>>) -> MappedRwLockWriteGuard<'static, T> {
let id = LocalContext::current_app().expect("no app running, `app_local` can only be accessed inside apps");
if let Some(i) = write.iter().position(|(s, _)| *s == id) {
return RwLockWriteGuard::map(write, |v| &mut v[i].1);
}
let value = (self.init)();
let i = write.len();
write.push((id, value));
LocalContext::register_cleanup(move |id| self.cleanup(id));
RwLockWriteGuard::map(write, |v| &mut v[i].1)
}
}
#[doc(hidden)]
pub trait AppLocalImpl<T: Send + Sync + 'static>: Send + Sync + 'static {
fn read(&'static self) -> MappedRwLockReadGuard<'static, T>;
fn try_read(&'static self) -> Option<MappedRwLockReadGuard<'static, T>>;
fn write(&'static self) -> MappedRwLockWriteGuard<'static, T>;
fn try_write(&'static self) -> Option<MappedRwLockWriteGuard<'static, T>>;
}
impl<T: Send + Sync + 'static> AppLocalImpl<T> for AppLocalVec<T> {
fn read(&'static self) -> MappedRwLockReadGuard<'static, T> {
self.read_impl(self.value.read_recursive())
}
fn try_read(&'static self) -> Option<MappedRwLockReadGuard<'static, T>> {
Some(self.read_impl(self.value.try_read_recursive()?))
}
fn write(&'static self) -> MappedRwLockWriteGuard<'static, T> {
self.write_impl(self.value.write())
}
fn try_write(&'static self) -> Option<MappedRwLockWriteGuard<'static, T>> {
Some(self.write_impl(self.value.try_write()?))
}
}
impl<T: Send + Sync + 'static> AppLocalImpl<T> for AppLocalOption<T> {
fn read(&'static self) -> MappedRwLockReadGuard<'static, T> {
self.read_impl(self.value.read_recursive())
}
fn try_read(&'static self) -> Option<MappedRwLockReadGuard<'static, T>> {
Some(self.read_impl(self.value.try_read_recursive()?))
}
fn write(&'static self) -> MappedRwLockWriteGuard<'static, T> {
self.write_impl(self.value.write())
}
fn try_write(&'static self) -> Option<MappedRwLockWriteGuard<'static, T>> {
Some(self.write_impl(self.value.try_write()?))
}
}
impl<T: Send + Sync + 'static> AppLocalImpl<T> for AppLocalConst<T> {
fn read(&'static self) -> MappedRwLockReadGuard<'static, T> {
RwLockReadGuard::map(self.value.read(), |l| l)
}
fn try_read(&'static self) -> Option<MappedRwLockReadGuard<'static, T>> {
Some(RwLockReadGuard::map(self.value.try_read()?, |l| l))
}
fn write(&'static self) -> MappedRwLockWriteGuard<'static, T> {
RwLockWriteGuard::map(self.value.write(), |l| l)
}
fn try_write(&'static self) -> Option<MappedRwLockWriteGuard<'static, T>> {
Some(RwLockWriteGuard::map(self.value.try_write()?, |l| l))
}
}
/// An app local storage.
///
/// This is similar to [`std::thread::LocalKey`], but works across all threads of the app.
///
/// Use the [`app_local!`] macro to declare a static variable in the same style as [`thread_local!`].
///
/// Note that in `"multi_app"` builds the app local can only be used if an app is running in the thread,
/// if no app is running read and write **will panic**.
pub struct AppLocal<T: Send + Sync + 'static> {
inner: fn() -> &'static dyn AppLocalImpl<T>,
}
impl<T: Send + Sync + 'static> AppLocal<T> {
#[doc(hidden)]
pub const fn new(inner: fn() -> &'static dyn AppLocalImpl<T>) -> Self {
AppLocal { inner }
}
/// Read lock the value associated with the current app.
///
/// Initializes the default value for the app if this is the first value access.
///
/// # Panics
///
/// Panics if no app is running in `"multi_app"` builds.
#[inline]
pub fn read(&'static self) -> MappedRwLockReadGuard<'static, T> {
(self.inner)().read()
}
/// Try read lock the value associated with the current app.
///
/// Initializes the default value for the app if this is the first value access.
///
/// Returns `None` if can’t acquire a read lock.
///
/// # Panics
///
/// Panics if no app is running in `"multi_app"` builds.
#[inline]
pub fn try_read(&'static self) -> Option<MappedRwLockReadGuard<'static, T>> {
(self.inner)().try_read()
}
/// Write lock the value associated with the current app.
///
/// Initializes the default value for the app if this is the first value access.
///
/// # Panics
///
/// Panics if no app is running in `"multi_app"` builds.
#[inline]
pub fn write(&'static self) -> MappedRwLockWriteGuard<'static, T> {
(self.inner)().write()
}
/// Try to write lock the value associated with the current app.
///
/// Initializes the default value for the app if this is the first value access.
///
/// Returns `None` if can’t acquire a write lock.
///
/// # Panics
///
/// Panics if no app is running in `"multi_app"` builds.
pub fn try_write(&'static self) -> Option<MappedRwLockWriteGuard<'static, T>> {
(self.inner)().try_write()
}
/// Get a clone of the value.
#[inline]
pub fn get(&'static self) -> T
where
T: Clone,
{
self.read().clone()
}
/// Set the value.
#[inline]
pub fn set(&'static self, value: T) {
*self.write() = value;
}
/// Try to get a clone of the value.
///
/// Returns `None` if can't acquire a read lock.
#[inline]
pub fn try_get(&'static self) -> Option<T>
where
T: Clone,
{
self.try_read().map(|l| l.clone())
}
/// Try to set the value.
///
/// Returns `Err(value)` if can't acquire a write lock.
#[inline]
pub fn try_set(&'static self, value: T) -> Result<(), T> {
match self.try_write() {
Some(mut l) => {
*l = value;
Ok(())
}
None => Err(value),
}
}
/// Create a read lock and `map` it to a sub-value.
#[inline]
pub fn read_map<O>(&'static self, map: impl FnOnce(&T) -> &O) -> MappedRwLockReadGuard<'static, O> {
MappedRwLockReadGuard::map(self.read(), map)
}
/// Try to create a read lock and `map` it to a sub-value.
#[inline]
pub fn try_read_map<O>(&'static self, map: impl FnOnce(&T) -> &O) -> Option<MappedRwLockReadGuard<'static, O>> {
let lock = self.try_read()?;
Some(MappedRwLockReadGuard::map(lock, map))
}
/// Create a write lock and `map` it to a sub-value.
#[inline]
pub fn write_map<O>(&'static self, map: impl FnOnce(&mut T) -> &mut O) -> MappedRwLockWriteGuard<'static, O> {
MappedRwLockWriteGuard::map(self.write(), map)
}
/// Try to create a write lock and `map` it to a sub-value.
#[inline]
pub fn try_write_map<O>(&'static self, map: impl FnOnce(&mut T) -> &mut O) -> Option<MappedRwLockWriteGuard<'static, O>> {
let lock = self.try_write()?;
Some(MappedRwLockWriteGuard::map(lock, map))
}
/// Gets an ID for this local instance that is valid for the lifetime of the process.
///
/// Note that comparing two `&'static LOCAL` pointers is incorrect, because in `"hot_reload"` builds the statics
/// can be different and still represent the same app local. This ID identifies the actual inner pointer.
pub fn id(&'static self) -> AppLocalId {
AppLocalId((self.inner)() as *const dyn AppLocalImpl<T> as *const () as _)
}
}
impl<T: Send + Sync + 'static> PartialEq for AppLocal<T> {
fn eq(&self, other: &Self) -> bool {
let a = AppLocalId((self.inner)() as *const dyn AppLocalImpl<T> as *const () as _);
let b = AppLocalId((other.inner)() as *const dyn AppLocalImpl<T> as *const () as _);
a == b
}
}
impl<T: Send + Sync + 'static> Eq for AppLocal<T> {}
impl<T: Send + Sync + 'static> std::hash::Hash for AppLocal<T> {
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
let a = AppLocalId((self.inner)() as *const dyn AppLocalImpl<T> as *const () as _);
std::hash::Hash::hash(&a, state)
}
}
/// Identifies an [`AppLocal<T>`] instance.
///
/// Note that comparing two `&'static LOCAL` pointers is incorrect, because in `"hot_reload"` builds the statics
/// can be different and still represent the same app local. This ID identifies the actual inner pointer, it is
/// valid for the lifetime of the process.
#[derive(PartialEq, Eq, Hash, Clone, Copy)]
pub struct AppLocalId(usize);
impl AppLocalId {
/// Get the underlying value.
pub fn get(self) -> usize {
// VarPtr depends on this being an actual pointer (must be unique against an `Arc<T>` raw pointer).
self.0 as _
}
}
impl fmt::Debug for AppLocalId {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "AppLocalId({:#x})", self.0)
}
}
///<span data-del-macro-root></span> Declares new app local variable.
///
/// An app local is a static variable that is declared using the same syntax as [`thread_local!`], but can be
/// accessed by any thread in the app. In apps that only run once per process it compiles down to the equivalent
/// of a `static LOCAL: RwLock<T> = const;` or `static LOCAL: RwLock<Option<T>>` that initializes on first usage. In test
/// builds with multiple parallel apps it compiles to a switching storage that provides a different value depending on
/// what app is running in the current thread.
///
/// See [`AppLocal<T>`] for more details.
///
/// # Multi App
///
/// If the crate is compiled with the `"multi_app"` feature a different internal implementation is used that supports multiple
/// apps, either running in parallel in different threads or one after the other. This backing implementation has some small overhead,
/// but usually you only want multiple app instances per-process when running tests.
///
/// The lifetime of `"multi_app"` locals is also more limited, trying to use an app-local before starting to build an app will panic,
/// the app-local value will be dropped when the app is dropped. Without the `"multi_app"` feature the app-locals can be used at
/// any point before or after the app lifetime, values are not explicitly dropped, just unloaded with the process.
///
/// # Const
///
/// The initialization expression can be wrapped in a `const { .. }` block, if the `"multi_app"` feature is **not** enabled
/// a faster implementation is used that is equivalent to a direct `static LOCAL: RwLock<T>` in terms of performance.
///
/// Note that this syntax is available even if the `"multi_app"` feature is enabled, the expression must be const either way,
/// but with the feature the same dynamic implementation is used.
///
/// Note that `const` initialization does not automatically convert the value into the static type.
///
/// # Examples
///
/// The example below declares two app locals, note that `BAR` init value automatically converts into the app local type.
///
/// ```
/// # use zng_app_context::*;
/// app_local! {
/// /// A public documented value.
/// pub static FOO: u8 = const { 10u8 };
///
/// // A private value.
/// static BAR: String = "Into!";
/// }
///
/// let app = LocalContext::start_app(AppId::new_unique());
///
/// assert_eq!(10, FOO.get());
/// ```
///
/// Also note that an app context is started before the first use, in `multi_app` builds trying to use an app local in
/// a thread not owned by an app panics.
#[macro_export]
macro_rules! app_local {
($(
$(#[$meta:meta])*
$vis:vis static $IDENT:ident : $T:ty = $(const { $init_const:expr })? $($init:expr)?;
)+) => {$(
$crate::app_local_impl! {
$(#[$meta])*
$vis static $IDENT: $T = $(const { $init_const })? $($init)?;
}
)+};
}
#[doc(hidden)]
#[macro_export]
macro_rules! app_local_impl_single {
(
$(#[$meta:meta])*
$vis:vis static $IDENT:ident : $T:ty = const { $init:expr };
) => {
$(#[$meta])*
$vis static $IDENT: $crate::AppLocal<$T> = {
fn s() -> &'static dyn $crate::AppLocalImpl<$T> {
$crate::hot_static! {
static IMPL: $crate::AppLocalConst<$T> = $crate::AppLocalConst::new($init);
}
$crate::hot_static_ref!(IMPL)
}
$crate::AppLocal::new(s)
};
};
(
$(#[$meta:meta])*
$vis:vis static $IDENT:ident : $T:ty = $init:expr;
) => {
$(#[$meta])*
$vis static $IDENT: $crate::AppLocal<$T> = {
fn s() -> &'static dyn $crate::AppLocalImpl<$T> {
fn init() -> $T {
std::convert::Into::into($init)
}
$crate::hot_static! {
static IMPL: $crate::AppLocalOption<$T> = $crate::AppLocalOption::new(init);
}
$crate::hot_static_ref!(IMPL)
}
$crate::AppLocal::new(s)
};
};
(
$(#[$meta:meta])*
$vis:vis static $IDENT:ident : $T:ty = ($tt:tt)*
) => {
std::compile_error!("expected `const { $expr };` or `$expr;`")
};
}
#[doc(hidden)]
#[macro_export]
macro_rules! app_local_impl_multi {
(
$(#[$meta:meta])*
$vis:vis static $IDENT:ident : $T:ty = const { $init:expr };
) => {
$(#[$meta])*
$vis static $IDENT: $crate::AppLocal<$T> = {
fn s() -> &'static dyn $crate::AppLocalImpl<$T> {
const fn init() -> $T {
$init
}
$crate::hot_static! {
static IMPL: $crate::AppLocalVec<$T> = $crate::AppLocalVec::new(init);
}
$crate::hot_static_ref!(IMPL)
}
$crate::AppLocal::new(s)
};
};
(
$(#[$meta:meta])*
$vis:vis static $IDENT:ident : $T:ty = $init:expr;
) => {
$(#[$meta])*
$vis static $IDENT: $crate::AppLocal<$T> = {
fn s() -> &'static dyn $crate::AppLocalImpl<$T> {
fn init() -> $T {
std::convert::Into::into($init)
}
$crate::hot_static! {
static IMPL: $crate::AppLocalVec<$T> = $crate::AppLocalVec::new(init);
}
$crate::hot_static_ref!(IMPL)
}
$crate::AppLocal::new(s)
};
};
(
$(#[$meta:meta])*
$vis:vis static $IDENT:ident : $T:ty = ($tt:tt)*
) => {
std::compile_error!("expected `const { $expr };` or `$expr;`")
};
}
#[cfg(feature = "multi_app")]
#[doc(hidden)]
pub use app_local_impl_multi as app_local_impl;
#[cfg(not(feature = "multi_app"))]
#[doc(hidden)]
pub use app_local_impl_single as app_local_impl;
/*
context_local!
*/
#[doc(hidden)]
pub struct ContextLocalData<T: Send + Sync + 'static> {
default_init: fn() -> T,
default_value: Option<Arc<T>>,
}
impl<T: Send + Sync + 'static> ContextLocalData<T> {
#[doc(hidden)]
pub const fn new(default_init: fn() -> T) -> Self {
Self {
default_init,
default_value: None,
}
}
}
/// Represents an [`AppLocal<T>`] value that can be temporarily overridden in a context.
///
/// The *context* works across threads, as long as the threads are instrumented using [`LocalContext`].
///
/// Use the [`context_local!`] macro to declare a static variable in the same style as [`thread_local!`].
pub struct ContextLocal<T: Send + Sync + 'static> {
data: AppLocal<ContextLocalData<T>>,
}
impl<T: Send + Sync + 'static> ContextLocal<T> {
#[doc(hidden)]
pub const fn new(storage: fn() -> &'static dyn AppLocalImpl<ContextLocalData<T>>) -> Self {
Self {
data: AppLocal::new(storage),
}
}
/// Gets an ID for this context local instance that is valid for the lifetime of the process.
///
/// Note that comparing two `&'static CTX_LOCAL` pointers is incorrect, because in `"hot_reload"` builds the statics
/// can be different and still represent the same app local. This ID identifies the actual inner pointer.
pub fn id(&'static self) -> AppLocalId {
self.data.id()
}
/// Calls `f` with the `value` loaded in context.
///
/// The `value` is moved into context, `f` is called, then the value is moved back to `value`.
///
/// # Panics
///
/// Panics if `value` is `None`.
pub fn with_context<R>(&'static self, value: &mut Option<Arc<T>>, f: impl FnOnce() -> R) -> R {
let mut r = None;
let f = || r = Some(f());
#[cfg(feature = "dyn_closure")]
let f: Box<dyn FnOnce()> = Box::new(f);
LocalContext::with_value_ctx(self, LocalValueKind::Local, value, f);
r.unwrap()
}
/// Same as [`with_context`], but `value` represents a variable.
///
/// Values loaded with this method are captured by [`CaptureFilter::ContextVars`].
///
/// [`with_context`]: Self::with_context
pub fn with_context_var<R>(&'static self, value: &mut Option<Arc<T>>, f: impl FnOnce() -> R) -> R {
let mut r = None;
let f = || r = Some(f());
#[cfg(feature = "dyn_closure")]
let f: Box<dyn FnOnce()> = Box::new(f);
LocalContext::with_value_ctx(self, LocalValueKind::Var, value, f);
r.unwrap()
}
/// Calls `f` with no value loaded in context.
pub fn with_default<R>(&'static self, f: impl FnOnce() -> R) -> R {
let mut r = None;
let f = || r = Some(f());
#[cfg(feature = "dyn_closure")]
let f: Box<dyn FnOnce()> = Box::new(f);
LocalContext::with_default_ctx(self, f);
r.unwrap()
}
/// Gets if no value is set in the context.
pub fn is_default(&'static self) -> bool {
!LocalContext::contains(self.id())
}
/// Clone a reference to the current value in the context or the default value.
pub fn get(&'static self) -> Arc<T> {
let cl = self.data.read();
match LocalContext::get(self.id()) {
Some(c) => Arc::downcast(c.0).unwrap(),
None => match &cl.default_value {
Some(d) => d.clone(),
None => {
drop(cl);
let mut cl = self.data.write();
match &cl.default_value {
None => {
let d = Arc::new((cl.default_init)());
cl.default_value = Some(d.clone());
d
}
Some(d) => d.clone(),
}
}
},
}
}
/// Clone the current value in the context or the default value.
pub fn get_clone(&'static self) -> T
where
T: Clone,
{
let cl = self.data.read();
match LocalContext::get(self.id()) {
Some(c) => c.0.downcast_ref::<T>().unwrap().clone(),
None => match &cl.default_value {
Some(d) => d.as_ref().clone(),
None => {
drop(cl);
let mut cl = self.data.write();
match &cl.default_value {
None => {
let val = (cl.default_init)();
let r = val.clone();
cl.default_value = Some(Arc::new(val));
r
}
Some(d) => d.as_ref().clone(),
}
}
},
}
}
}
impl<T: Send + Sync + 'static> ContextLocal<RwLock<T>> {
/// Gets a read-only shared reference to the current context value.
pub fn read_only(&'static self) -> ReadOnlyRwLock<T> {
ReadOnlyRwLock::new(self.get())
}
/// Locks this `RwLock` with shared read access, blocking the current thread until it can be acquired.
///
/// See `parking_lot::RwLock::read` for more details.
pub fn read(&'static self) -> RwLockReadGuardOwned<T> {
RwLockReadGuardOwned::lock(self.get())
}
/// Locks this `RwLock` with shared read access, blocking the current thread until it can be acquired.
///
/// Unlike `read`, this method is guaranteed to succeed without blocking if
/// another read lock is held at the time of the call.
///
/// See `parking_lot::RwLock::read` for more details.
pub fn read_recursive(&'static self) -> RwLockReadGuardOwned<T> {
RwLockReadGuardOwned::lock_recursive(self.get())
}
/// Locks this `RwLock` with exclusive write access, blocking the current
/// thread until it can be acquired.
///
/// See `parking_lot::RwLock::write` for more details.
pub fn write(&'static self) -> RwLockWriteGuardOwned<T> {
RwLockWriteGuardOwned::lock(self.get())
}
/// Try lock this `RwLock` with shared read access, blocking the current thread until it can be acquired.
///
/// See `parking_lot::RwLock::try_read` for more details.
pub fn try_read(&'static self) -> Option<RwLockReadGuardOwned<T>> {
RwLockReadGuardOwned::try_lock(self.get())
}
/// Locks this `RwLock` with shared read access, blocking the current thread until it can be acquired.
///
/// See `parking_lot::RwLock::try_read_recursive` for more details.
pub fn try_read_recursive(&'static self) -> Option<RwLockReadGuardOwned<T>> {
RwLockReadGuardOwned::try_lock_recursive(self.get())
}
/// Locks this `RwLock` with exclusive write access, blocking the current
/// thread until it can be acquired.
///
/// See `parking_lot::RwLock::try_write` for more details.
pub fn try_write(&'static self) -> Option<RwLockWriteGuardOwned<T>> {
RwLockWriteGuardOwned::try_lock(self.get())
}
}
/// Represents a read guard for an `Arc<RwLock<T>>` that owns a reference to it.
pub struct RwLockReadGuardOwned<T: 'static> {
lock: parking_lot::RwLockReadGuard<'static, T>,
_owned: Arc<RwLock<T>>,
}
impl<T> RwLockReadGuardOwned<T> {
/// Lock owned.
///
/// See `parking_lot::RwLock::read` for more details.
pub fn lock(own: Arc<RwLock<T>>) -> Self {
Self {
// SAFETY: we cast to 'static only for storage, `lock` is dropped before `_owned`.
lock: unsafe { mem::transmute::<parking_lot::RwLockReadGuard<'_, T>, parking_lot::RwLockReadGuard<'static, T>>(own.read()) },
_owned: own,
}
}
/// Locks this `RwLock` with shared read access, blocking the current thread until it can be acquired.
///
/// See `parking_lot::RwLock::read_recursive` for more details.
pub fn lock_recursive(own: Arc<RwLock<T>>) -> Self {
Self {
// SAFETY: we cast to 'static only for storage, `lock` is dropped before `_owned`.
lock: unsafe {
mem::transmute::<parking_lot::RwLockReadGuard<'_, T>, parking_lot::RwLockReadGuard<'static, T>>(own.read_recursive())
},
_owned: own,
}
}
/// Try lock owned.
///
/// See `parking_lot::RwLock::try_read` for more details.
pub fn try_lock(own: Arc<RwLock<T>>) -> Option<Self> {
let lock = own.try_read()?;
Some(Self {
// SAFETY: we cast to 'static only for storage, `lock` is dropped before `_owned`.
lock: unsafe { mem::transmute::<parking_lot::RwLockReadGuard<'_, T>, parking_lot::RwLockReadGuard<'static, T>>(lock) },
_owned: own,
})
}
/// Try lock owned.
///
/// See `parking_lot::RwLock::try_read` for more details.
pub fn try_lock_recursive(own: Arc<RwLock<T>>) -> Option<Self> {
let lock = own.try_read_recursive()?;
Some(Self {
// SAFETY: we cast to 'static only for storage, `lock` is dropped before `_owned`.
lock: unsafe { mem::transmute::<parking_lot::RwLockReadGuard<'_, T>, parking_lot::RwLockReadGuard<'static, T>>(lock) },
_owned: own,
})
}
/// Make a new `MappedRwLockReadGuardOwned` for a component of the locked data.
///
/// This is an associated function that needs to be
/// used as `RwLockReadGuardOwned::map(...)`. A method would interfere with methods of
/// the same name on the contents of the locked data.
pub fn map<O>(guard: Self, map: impl FnOnce(&T) -> &O) -> MappedRwLockReadGuardOwned<T, O> {
MappedRwLockReadGuardOwned {
lock: parking_lot::RwLockReadGuard::map(guard.lock, map),
_owned: guard._owned,
}
}
}
impl<T> ops::Deref for RwLockReadGuardOwned<T> {
type Target = T;
fn deref(&self) -> &Self::Target {
self.lock.deref()
}
}
/// Represents a read guard for an `Arc<RwLock<T>>` that owns a reference to it, mapped from another read guard.
pub struct MappedRwLockReadGuardOwned<T: 'static, O: 'static> {
lock: parking_lot::MappedRwLockReadGuard<'static, O>,
_owned: Arc<RwLock<T>>,
}
impl<T, O> MappedRwLockReadGuardOwned<T, O> {
/// Make a new `MappedRwLockReadGuardOwned` for a component of the locked data.
///
/// This is an associated function that needs to be
/// used as `MappedRwLockReadGuardOwned::map(...)`. A method would interfere with methods of
/// the same name on the contents of the locked data.
pub fn map<O2>(guard: Self, map: impl FnOnce(&O) -> &O2) -> MappedRwLockReadGuardOwned<T, O2> {
MappedRwLockReadGuardOwned {
lock: parking_lot::MappedRwLockReadGuard::map(guard.lock, map),
_owned: guard._owned,
}
}
}
impl<T, O> ops::Deref for MappedRwLockReadGuardOwned<T, O> {
type Target = O;
fn deref(&self) -> &Self::Target {
self.lock.deref()
}
}
/// Represents a read guard for an `Arc<RwLock<T>>` that owns a reference to it.
pub struct RwLockWriteGuardOwned<T: 'static> {
lock: parking_lot::RwLockWriteGuard<'static, T>,
_owned: Arc<RwLock<T>>,
}
impl<T> RwLockWriteGuardOwned<T> {
/// Lock owned.
///
/// See `parking_lot::RwLock::write` for more details.
pub fn lock(own: Arc<RwLock<T>>) -> Self {
Self {
// SAFETY: we cast to 'static only for storage, `lock` is dropped before `_owned`.
lock: unsafe { mem::transmute::<parking_lot::RwLockWriteGuard<'_, T>, parking_lot::RwLockWriteGuard<'static, T>>(own.write()) },
_owned: own,
}
}
/// Lock owned.
///
/// See `parking_lot::RwLock::try_write` for more details.
pub fn try_lock(own: Arc<RwLock<T>>) -> Option<Self> {
let lock = own.try_write()?;
Some(Self {
// SAFETY: we cast to 'static only for storage, `lock` is dropped before `_owned`.
lock: unsafe { mem::transmute::<parking_lot::RwLockWriteGuard<'_, T>, parking_lot::RwLockWriteGuard<'static, T>>(lock) },
_owned: own,
})
}
/// Make a new `MappedRwLockReadGuardOwned` for a component of the locked data.
///
/// This is an associated function that needs to be
/// used as `MappedRwLockReadGuardOwned::map(...)`. A method would interfere with methods of
/// the same name on the contents of the locked data.
pub fn map<O>(guard: Self, map: impl FnOnce(&mut T) -> &mut O) -> MappedRwLockWriteGuardOwned<T, O> {
MappedRwLockWriteGuardOwned {
lock: parking_lot::RwLockWriteGuard::map(guard.lock, map),
_owned: guard._owned,
}
}
}
impl<T> ops::Deref for RwLockWriteGuardOwned<T> {
type Target = T;
fn deref(&self) -> &Self::Target {
self.lock.deref()
}
}
impl<T> ops::DerefMut for RwLockWriteGuardOwned<T> {
fn deref_mut(&mut self) -> &mut Self::Target {
self.lock.deref_mut()
}
}
/// Represents a write guard for an `Arc<RwLock<T>>` that owns a reference to it, mapped from another read guard.
pub struct MappedRwLockWriteGuardOwned<T: 'static, O: 'static> {
lock: parking_lot::MappedRwLockWriteGuard<'static, O>,
_owned: Arc<RwLock<T>>,
}
impl<T, O> MappedRwLockWriteGuardOwned<T, O> {
/// Make a new `MappedRwLockWriteGuardOwned` for a component of the locked data.
///
/// This is an associated function that needs to be
/// used as `MappedRwLockWriteGuardOwned::map(...)`. A method would interfere with methods of
/// the same name on the contents of the locked data.
pub fn map<O2>(guard: Self, map: impl FnOnce(&mut O) -> &mut O2) -> MappedRwLockWriteGuardOwned<T, O2> {
MappedRwLockWriteGuardOwned {
lock: parking_lot::MappedRwLockWriteGuard::map(guard.lock, map),
_owned: guard._owned,
}
}
}
impl<T, O> ops::Deref for MappedRwLockWriteGuardOwned<T, O> {
type Target = O;
fn deref(&self) -> &Self::Target {
self.lock.deref()
}
}
impl<T, O> ops::DerefMut for MappedRwLockWriteGuardOwned<T, O> {
fn deref_mut(&mut self) -> &mut Self::Target {
self.lock.deref_mut()
}
}
/// Read-only wrapper on an `Arc<RwLock<T>>` contextual value.
pub struct ReadOnlyRwLock<T>(Arc<RwLock<T>>);
impl<T> Clone for ReadOnlyRwLock<T> {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}
impl<T> ReadOnlyRwLock<T> {
/// New.
pub fn new(l: Arc<RwLock<T>>) -> Self {
Self(l)
}
/// Locks this `RwLock` with shared read access, blocking the current thread until it can be acquired.
///
/// See `parking_lot::RwLock::read` for more details.
pub fn read(&self) -> parking_lot::RwLockReadGuard<T> {
self.0.read()
}
/// Locks this `RwLock` with shared read access, blocking the current thread until it can be acquired.
///
/// Unlike `read`, this method is guaranteed to succeed without blocking if
/// another read lock is held at the time of the call.
///
/// See `parking_lot::RwLock::read_recursive` for more details.
pub fn read_recursive(&self) -> parking_lot::RwLockReadGuard<T> {
self.0.read_recursive()
}
/// Attempts to acquire this `RwLock` with shared read access.
///
/// See `parking_lot::RwLock::try_read` for more details.
pub fn try_read(&self) -> Option<parking_lot::RwLockReadGuard<T>> {
self.0.try_read()
}
/// Attempts to acquire this `RwLock` with shared read access.
///
/// See `parking_lot::RwLock::try_read_recursive` for more details.
pub fn try_read_recursive(&self) -> Option<parking_lot::RwLockReadGuard<T>> {
self.0.try_read_recursive()
}
/// Gets if the read-only shared reference is to the same lock as `other`.
pub fn ptr_eq(&self, other: &Self) -> bool {
Arc::ptr_eq(&self.0, &other.0)
}
}
///<span data-del-macro-root></span> Declares new app and context local variable.
///
/// # Examples
///
/// ```
/// # use zng_app_context::*;
/// context_local! {
/// /// A public documented value.
/// pub static FOO: u8 = 10u8;
///
/// // A private value.
/// static BAR: String = "Into!";
/// }
/// ```
///
/// # Default Value
///
/// All contextual values must have a fallback value that is used when no context is loaded.
///
/// The default value is instantiated once per app, the expression can be any static value that converts [`Into<T>`].
///
/// # Usage
///
/// After you declare the context local you can use it by loading a contextual value for the duration of a closure call.
///
/// ```
/// # use zng_app_context::*;
/// # use std::sync::Arc;
/// context_local! { static FOO: String = "default"; }
///
/// fn print_value() {
/// println!("value is {}!", FOO.get());
/// }
///
/// let _scope = LocalContext::start_app(AppId::new_unique());
///
/// let mut value = Some(Arc::new(String::from("other")));
/// FOO.with_context(&mut value, || {
/// print!("in context, ");
/// print_value();
/// });
///
/// print!("out of context, ");
/// print_value();
/// ```
///
/// The example above prints:
///
/// ```text
/// in context, value is other!
/// out of context, value is default!
/// ```
///
/// See [`ContextLocal<T>`] for more details.
#[macro_export]
macro_rules! context_local {
($(
$(#[$meta:meta])*
$vis:vis static $IDENT:ident : $T:ty = $init:expr;
)+) => {$(
$crate::context_local_impl! {
$(#[$meta])*
$vis static $IDENT: $T = $init;
}
)+};
}
#[doc(hidden)]
#[macro_export]
macro_rules! context_local_impl_single {
($(
$(#[$meta:meta])*
$vis:vis static $IDENT:ident : $T:ty = $init:expr;
)+) => {$(
$(#[$meta])*
$vis static $IDENT: $crate::ContextLocal<$T> = {
fn s() -> &'static dyn $crate::AppLocalImpl<$crate::ContextLocalData<$T>> {
fn init() -> $T {
std::convert::Into::into($init)
}
$crate::hot_static! {
static IMPL: $crate::AppLocalConst<$crate::ContextLocalData<$T>> =
$crate::AppLocalConst::new(
$crate::ContextLocalData::new(init)
);
}
$crate::hot_static_ref!(IMPL)
}
$crate::ContextLocal::new(s)
};
)+};
}
#[doc(hidden)]
#[macro_export]
macro_rules! context_local_impl_multi {
($(
$(#[$meta:meta])*
$vis:vis static $IDENT:ident : $T:ty = $init:expr;
)+) => {$(
$(#[$meta])*
$vis static $IDENT: $crate::ContextLocal<$T> = {
fn s() -> &'static dyn $crate::AppLocalImpl<$crate::ContextLocalData<$T>> {
fn init() -> $T {
std::convert::Into::into($init)
}
$crate::hot_static! {
static IMPL: $crate::AppLocalVec<$crate::ContextLocalData<$T>> =
$crate::AppLocalVec::new(
|| $crate::ContextLocalData::new(init)
);
}
$crate::hot_static_ref!(IMPL)
}
$crate::ContextLocal::new(s)
};
)+};
}
#[cfg(feature = "multi_app")]
#[doc(hidden)]
pub use context_local_impl_multi as context_local_impl;
#[cfg(not(feature = "multi_app"))]
#[doc(hidden)]
pub use context_local_impl_single as context_local_impl;
/// Defines a [`LocalContext::capture_filtered`] filter.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CaptureFilter {
/// Don't capture anything, equivalent of [`LocalContext::new`].
None,
/// Capture all [`context_local!`] values and [`TracingDispatcherContext`].
All,
/// Capture all variables not excluded, no [`context_local!`] nor [`TracingDispatcherContext`].
ContextVars {
/// Vars to not include.
exclude: ContextValueSet,
},
/// Capture all [`context_local!`] and [`TracingDispatcherContext`] not excluded, no context variables.
ContextLocals {
/// Locals to not include.
exclude: ContextValueSet,
},
/// Capture only this set.
Include(ContextValueSet),
/// Capture all except this set.
Exclude(ContextValueSet),
}
impl CaptureFilter {
/// Capture all variables, no [`context_local!`] nor [`TracingDispatcherContext`].
pub const fn context_vars() -> Self {
Self::ContextVars {
exclude: ContextValueSet::new(),
}
}
/// Capture all [`context_local!`] and [`TracingDispatcherContext`], no context variables.
pub const fn context_locals() -> Self {
Self::ContextLocals {
exclude: ContextValueSet::new(),
}
}
/// Only capture the [`app_local!`] and [`TracingDispatcherContext`].
pub fn app_only() -> Self {
let mut set = ContextValueSet::new();
set.insert_app();
Self::Include(set)
}
}
/// Provides an identifying key for a context local value.
///
/// Implemented by all [`ContextLocal<T>`] already, only implement this for context local thin wrappers.
pub trait ContextLocalKeyProvider {
/// Gets the key.
fn context_local_key(&'static self) -> AppLocalId;
}
impl<T: Send + Sync + 'static> ContextLocalKeyProvider for ContextLocal<T> {
fn context_local_key(&'static self) -> AppLocalId {
self.id()
}
}
/// Represents the [`tracing::dispatcher::get_default`] dispatcher in a context value set.
///
/// [`tracing::dispatcher::get_default`]: https://docs.rs/tracing/latest/tracing/dispatcher/fn.get_global_default.html
pub struct TracingDispatcherContext;
impl ContextLocalKeyProvider for TracingDispatcherContext {
fn context_local_key(&'static self) -> AppLocalId {
static ID: bool = true;
AppLocalId(&ID as *const bool as *const () as usize)
}
}
/// Identifies a selection of [`LocalContext`] values.
#[derive(Default, Clone, PartialEq, Eq)]
pub struct ContextValueSet(LocalSet);
impl ContextValueSet {
/// New empty.
pub const fn new() -> Self {
Self(new_local_set())
}
/// Insert a context local.
pub fn insert(&mut self, value: &'static impl ContextLocalKeyProvider) -> bool {
self.0.insert(value.context_local_key())
}
/// Remove a context local.
pub fn remove(&mut self, value: &'static impl ContextLocalKeyProvider) -> bool {
self.0.remove(&value.context_local_key())
}
/// Checks if the context local is in the set.
pub fn contains(&self, value: &'static impl ContextLocalKeyProvider) -> bool {
self.0.contains(&value.context_local_key())
}
/// Number of unique values in the set.
pub fn len(&self) -> usize {
self.0.len()
}
/// If the set has any values.
pub fn is_empty(&self) -> bool {
self.0.is_empty()
}
/// Extend this set with all `other` contexts.
pub fn insert_all(&mut self, other: &Self) {
self.0.extend(other.0.iter().copied());
}
/// Removes all `other` contexts from this set.
pub fn remove_all(&mut self, other: &Self) {
for o in other.0.iter() {
self.0.remove(o);
}
}
/// Insert the [`app_local!`] ID and [`TracingDispatcherContext`].
pub fn insert_app(&mut self) -> bool {
let inserted_app = self.0.insert(AppId::local_id());
static TRACING: TracingDispatcherContext = TracingDispatcherContext;
self.insert(&TRACING) || inserted_app
}
}
impl fmt::Debug for ContextValueSet {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("ContextValueSet").field("len()", &self.len()).finish()
}
}
/// Helper, runs a cleanup action once on drop.
pub struct RunOnDrop<F: FnOnce()>(Option<F>);
impl<F: FnOnce()> RunOnDrop<F> {
/// New with closure that will run once on drop.
pub fn new(clean: F) -> Self {
RunOnDrop(Some(clean))
}
}
impl<F: FnOnce()> Drop for RunOnDrop<F> {
fn drop(&mut self) {
if let Some(clean) = self.0.take() {
clean();
}
}
}
fn panic_str<'s>(payload: &'s Box<dyn std::any::Any + Send + 'static>) -> &'s str {
if let Some(s) = payload.downcast_ref::<&str>() {
s
} else if let Some(s) = payload.downcast_ref::<String>() {
s
} else {
"<unknown-panic-message-type>"
}
}