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
/*!
The [`Setup`] type.
All functionality in `emit` is based on a [`crate::runtime::Runtime`]. When you call [`Setup::init`], it initializes the [`crate::runtime::shared`] runtime for you, which is also what macros use by default.
You can implement your own runtime, providing your own implementations of the ambient clock, randomness, and global context. First, disable the default features of `emit` in your `Cargo.toml`:
```toml
[dependencies.emit]
version = "0.11.0-alpha.15"
default-features = false
features = ["std"]
```
This will ensure the `rt` control parameter is always passed to macros so that your custom runtime will always be used.
You can define your runtime as a [`crate::runtime::AmbientSlot`] in a static and initialize it through [`Setup::init_slot`]:
```
// Define a static runtime to use
// In this example, we use the default implementations of most things,
// but you can also bring-your-own
static RUNTIME: emit::runtime::AmbientSlot = emit::runtime::AmbientSlot::new();
let rt = emit::setup()
.emit_to(emit::emitter::from_fn(|evt| println!("{}", evt.msg())))
.init_slot(&RUNTIME);
// Use your runtime with the `rt` control parameter
emit::emit!(rt: RUNTIME.get(), "emitted through a custom runtime");
rt.blocking_flush(std::time::Duration::from_secs(5));
```
```text
emitted through a custom runtime
```
The [`crate::runtime::AmbientSlot`] is type-erased, but you can also define your own fully concrete runtimes too:
```
// Define a static runtime to use
// In this example, we use the default implementations of most things,
// but you can also bring-your-own
static RUNTIME: emit::runtime::Runtime<
MyEmitter,
emit::Empty,
emit::platform::thread_local_ctxt::ThreadLocalCtxt,
emit::platform::system_clock::SystemClock,
emit::platform::rand_rng::RandRng,
> = emit::runtime::Runtime::build(
MyEmitter,
emit::Empty,
emit::platform::thread_local_ctxt::ThreadLocalCtxt::shared(),
emit::platform::system_clock::SystemClock::new(),
emit::platform::rand_rng::RandRng::new(),
);
struct MyEmitter;
impl emit::Emitter for MyEmitter {
fn emit<E: emit::event::ToEvent>(&self, evt: E) {
println!("{}", evt.to_event().msg());
}
fn blocking_flush(&self, _: std::time::Duration) -> bool {
// Nothing to flush
true
}
}
// Use your runtime with the `rt` control parameter
emit::emit!(rt: &RUNTIME, "emitted through a custom runtime");
```
```text
emitted through a custom runtime
```
*/
use core::time::Duration;
use emit_core::{
and::And,
ctxt::Ctxt,
emitter::Emitter,
empty::Empty,
filter::Filter,
runtime::{AmbientRuntime, AmbientSlot, InternalCtxt, InternalEmitter, InternalFilter},
};
use crate::platform::{self, Platform};
/**
Configure `emit` with [`Emitter`]s, [`Filter`]s, and [`Ctxt`].
This function should be called as early in your application as possible. It returns a [`Setup`] builder that, once configured, can be initialized with a call to [`Setup::init`].
*/
pub fn setup() -> Setup {
Setup::default()
}
pub use platform::{DefaultClock, DefaultCtxt, DefaultRng};
/**
The default [`Emitter`] to use in [`setup()`].
*/
pub type DefaultEmitter = Empty;
/**
The default [`Filter`] to use in [`setup()`].
*/
pub type DefaultFilter = Empty;
/**
A configuration builder for an `emit` runtime.
*/
#[must_use = "call `.init()` to finish setup"]
pub struct Setup<TEmitter = DefaultEmitter, TFilter = DefaultFilter, TCtxt = DefaultCtxt> {
emitter: TEmitter,
filter: TFilter,
ctxt: TCtxt,
platform: Platform,
}
impl Default for Setup {
fn default() -> Self {
Self::new()
}
}
impl Setup {
/**
Create a new builder with the default [`Emitter`], [`Filter`], and [`Ctxt`].
*/
pub fn new() -> Self {
Setup {
emitter: Default::default(),
filter: Default::default(),
ctxt: Default::default(),
platform: Default::default(),
}
}
}
impl<TEmitter: Emitter, TFilter: Filter, TCtxt: Ctxt> Setup<TEmitter, TFilter, TCtxt> {
/**
Set the [`Emitter`] that will receive diagnostic events.
*/
pub fn emit_to<UEmitter: Emitter>(self, emitter: UEmitter) -> Setup<UEmitter, TFilter, TCtxt> {
Setup {
emitter,
filter: self.filter,
ctxt: self.ctxt,
platform: self.platform,
}
}
/**
Add an [`Emitter`] that will also receive diagnostic events.
*/
pub fn and_emit_to<UEmitter: Emitter>(
self,
emitter: UEmitter,
) -> Setup<And<TEmitter, UEmitter>, TFilter, TCtxt> {
Setup {
emitter: self.emitter.and_to(emitter),
filter: self.filter,
ctxt: self.ctxt,
platform: self.platform,
}
}
/**
Map the current [`Emitter`] into a new value.
*/
pub fn map_emitter<UEmitter: Emitter>(
self,
map: impl FnOnce(TEmitter) -> UEmitter,
) -> Setup<UEmitter, TFilter, TCtxt> {
Setup {
emitter: map(self.emitter),
filter: self.filter,
ctxt: self.ctxt,
platform: self.platform,
}
}
/**
Set the [`Filter`] that will be applied before diagnostic events are emitted.
*/
pub fn emit_when<UFilter: Filter>(self, filter: UFilter) -> Setup<TEmitter, UFilter, TCtxt> {
Setup {
emitter: self.emitter,
filter,
ctxt: self.ctxt,
platform: self.platform,
}
}
/**
Set the [`Ctxt`] that will store ambient properties and attach them to diagnostic events.
*/
pub fn with_ctxt<UCtxt: Ctxt>(self, ctxt: UCtxt) -> Setup<TEmitter, TFilter, UCtxt> {
Setup {
emitter: self.emitter,
filter: self.filter,
ctxt,
platform: self.platform,
}
}
/**
Map the current [`Ctxt`] into a new value.
*/
pub fn map_ctxt<UCtxt: Ctxt>(
self,
map: impl FnOnce(TCtxt) -> UCtxt,
) -> Setup<TEmitter, TFilter, UCtxt> {
Setup {
emitter: self.emitter,
filter: self.filter,
ctxt: map(self.ctxt),
platform: self.platform,
}
}
}
impl<
TEmitter: Emitter + Send + Sync + 'static,
TFilter: Filter + Send + Sync + 'static,
TCtxt: Ctxt + Send + Sync + 'static,
> Setup<TEmitter, TFilter, TCtxt>
where
TCtxt::Frame: Send + 'static,
{
/**
Initialize the default runtime used by `emit` macros.
This method initializes [`crate::runtime::shared`].
*/
#[must_use = "call `blocking_flush` at the end of `main` to ensure events are flushed."]
#[cfg(feature = "implicit_rt")]
pub fn init(self) -> Init<'static, TEmitter, TCtxt> {
self.init_slot(emit_core::runtime::shared_slot())
}
/**
Initialize a runtime in the given static `slot`.
*/
#[must_use = "call `blocking_flush` at the end of `main` to ensure events are flushed."]
pub fn init_slot<'a>(self, slot: &'a AmbientSlot) -> Init<'a, TEmitter, TCtxt> {
let ambient = slot
.init(
emit_core::runtime::Runtime::new()
.with_emitter(self.emitter)
.with_filter(self.filter)
.with_ctxt(self.ctxt)
.with_clock(self.platform.clock)
.with_rng(self.platform.rng),
)
.expect("already initialized");
Init {
rt: slot.get(),
emitter: *ambient.emitter(),
ctxt: *ambient.ctxt(),
}
}
}
impl<
TEmitter: InternalEmitter + Send + Sync + 'static,
TFilter: InternalFilter + Send + Sync + 'static,
TCtxt: InternalCtxt + Send + Sync + 'static,
> Setup<TEmitter, TFilter, TCtxt>
where
TCtxt::Frame: Send + 'static,
{
/**
Initialize the internal runtime used for diagnosing runtimes themselves.
This method initializes [`crate::runtime::internal`].
*/
#[must_use = "call `blocking_flush` at the end of `main` (after flushing the main runtime) to ensure events are flushed."]
#[cfg(feature = "implicit_internal_rt")]
pub fn init_internal(self) -> Init<'static, TEmitter, TCtxt> {
let slot = emit_core::runtime::internal_slot();
let ambient = slot
.init(
emit_core::runtime::Runtime::new()
.with_emitter(self.emitter)
.with_filter(self.filter)
.with_ctxt(self.ctxt)
.with_clock(self.platform.clock)
.with_rng(self.platform.rng),
)
.expect("already initialized");
Init {
rt: slot.get(),
emitter: *ambient.emitter(),
ctxt: *ambient.ctxt(),
}
}
}
/**
The result of calling [`Setup::init`].
This type is a handle to an initialized runtime that can be used to ensure it's fully flushed with a call to [`Init::blocking_flush`] before your application exits.
*/
pub struct Init<'a, TEmitter: Emitter + ?Sized = DefaultEmitter, TCtxt: Ctxt + ?Sized = DefaultCtxt>
{
rt: &'a AmbientRuntime<'a>,
emitter: &'a TEmitter,
ctxt: &'a TCtxt,
}
impl<'a, TEmitter: Emitter + ?Sized, TCtxt: Ctxt + ?Sized> Init<'a, TEmitter, TCtxt> {
/**
Get a reference to the initialized [`Emitter`].
*/
pub fn emitter(&self) -> &'a TEmitter {
self.emitter
}
/**
Get a reference to the initialized [`Ctxt`].
*/
pub fn ctxt(&self) -> &'a TCtxt {
self.ctxt
}
/**
Flush the runtime, ensuring all diagnostic events are fully processed.
This method forwards to [`Emitter::blocking_flush`], which has details on how the timeout is handled.
*/
pub fn blocking_flush(&self, timeout: Duration) -> bool {
self.emitter.blocking_flush(timeout)
}
/**
Get the underlying runtime that was initialized.
*/
pub fn get(&self) -> &'a AmbientRuntime<'a> {
self.rt
}
}