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
//! A lightweight, `no_std`-friendly logging library for Rust
//! with support for compile-time filtering and optional runtime level control.
//!
//! > **Minimum Supported Rust Version:** `1.56.0`
//!
//! # Usage
//!
//! Add `loggery` to your `Cargo.toml`:
//!
//! ```toml
//! [dependencies]
//! loggery = "0.1.0"
//! ```
//!
//! Then use the logging macros:
//!
//! ```
//! use loggery::{trace, debug, info, warn, error};
//!
//! trace!("This is a TRACE log!");
//! debug!("This is a DEBUG log!");
//! info!("This is an INFO log!");
//! warn!("This is a WARN log!");
//! error!("This is an ERROR log!");
//! ```
//!
//! Output (default logger format):
//!
//! ```text
//! [TRACE] This is a TRACE log!
//! [DEBUG] This is a DEBUG log!
//! [ INFO] This is an INFO log!
//! [ WARN] This is a WARN log!
//! [ERROR] This is an ERROR log!
//! ```
//!
//! # Custom Logger
//!
//! By default, logs are written in the format: `[LEVEL] message`,
//! e.g., `[ERROR] Something went wrong!`.
//!
//! But you can implement your own:
//!
//! ```
//! use loggery::{Payload, debug};
//!
//! fn my_logger(payload: Payload) {
//! // Your custom implementation
//!
//! // For example, you can change the format of the logger
//! println!("[APPLICATION]-{}-({})", payload.level.as_str(), payload.args);
//! }
//!
//! fn main() {
//! # #[cfg(not(feature = "static"))]
//! loggery::set_logger(my_logger);
//!
//! debug!("A log message using my custom logger!");
//! }
//! ```
//!
//! Output:
//!
//! ```text
//! [APPLICATION]-DEBUG-(A log message using my custom logger!)
//! ```
//!
//! > **Note:** [`set_logger`] isn't available if the `static` feature is enabled!
//! > Read [Static](#static) for more details.
//!
//! # Runtime Level
//!
//! > **Note:** Only available when the `runtime_level` feature is enabled (enabled by default).
//!
//! You can dynamically change the minimum log level at runtime using [`set_min_level`]:
//!
//! ```
//! use loggery::{Level, debug, warn};
//!
//! # #[cfg(feature = "runtime_level")]
//! loggery::set_min_level(Level::Warn);
//!
//! debug!("This will NOT be logged");
//! warn!("This will be logged");
//! ```
//!
//! This works alongside compile-time filtering using `min_level_*` features.
//! Runtime filtering can only be more restrictive, not less restrictive than compile-time feature.
//! For example if the `min_level_info` feature is enabled, [`debug!`], [`trace!`] calls are
//! removed at compile-time and cannot be re-enabled at runtime.
//!
//! # Static
//!
//! > **Note:** Only available when the `static` feature is enabled.
//!
//! For maximum performance or in embedded/performance-critical applications, use the `static`
//! feature to remove the runtime indirection. Your logger is linked directly at compile time:
//!
//! ```toml
//! [dependencies]
//! loggery = { version = "0.1.0", default-features = false, features = ["static"]}
//! ```
//!
//! Then define your logger implementation in your binary crate:
//!
//! ```no_run
//! use loggery::{Payload, debug};
//!
//! #[no_mangle]
//! pub extern "Rust" fn __loggery_log_impl(payload: Payload) {
//! // Your custom implementation
//! }
//!
//! fn main() {
//! debug!("Direct call from custom static implementation!")
//! }
//! ```
//! > **Tip:** The feature combination of `std` and `static` is possible, but you'd still have to
//! > define `__loggery_log_impl` function. If you want to use the default stdout static definition
//! > provided by the crate, use `static_default` feature (enables `std` and `static` features
//! > automatically):
//! >
//! > ```toml
//! > loggery = { version = "0.1.0", features = ["static_default"] }
//! > ```
//! >
//! > This gives you direct compile-time linking without needing to define `__loggery_log_impl`.
//!
//! > **Note:** When using `static_default` feature, you **cannot** define your own
//! > `__loggery_log_impl` function, as this will cause a duplicate symbol linker error!
//!
//! > **Tip:** Even with `static` feature, you can still use the `runtime_level` feature and
//! > therefore the [`set_min_level`] function to do runtime log level filtering.
//!
//! <div class="warning">
//!
//! When using the `static` feature, you **must** define `__loggery_log_impl` function in your
//! binary crate, or you'll get a linker error!
//!
//! </div>
//!
//! # Extensions
//!
//! > **Note:** Only available when the `extension` feature is enabled.
//!
//! Extensions provide a hook for extra processing *alongside* the actual logger. They're called
//! before the logger and receive a reference to the [`Payload`], giving you the ability to:
//! - Save logs to files
//! - Send logs to external services
//! - Collect metrics
//! - etc.
//!
//! ```
//! use loggery::{Payload, debug};
//!
//! fn my_extension(payload: &Payload) {
//! // Your custom implementation
//!
//! // For example, you can use the provided extension `save_to_file`
//! # #[cfg(all(feature = "extension", not(feature = "static")))]
//! let _ = loggery::extensions::save_to_file(payload, "path/to/app.log");
//! }
//!
//! fn main() {
//! # #[cfg(all(feature = "extension", not(feature = "static")))]
//! loggery::set_extension(my_extension);
//!
//! debug!("A log message that will be saved to a file too!");
//! }
//! ```
//!
//! > **Note:** When the `static` feature is enabled, `set_extension` isn't available. Instead,
//! > you must do this:
//! >
//! > ```no_run
//! > use loggery::Payload;
//! >
//! > #[no_mangle]
//! > pub extern "Rust" fn __loggery_extension_impl(payload: &Payload) {
//! > // Your custom implementation
//! > }
//! > ```
//!
//! <div class="warning">
//!
//! When using `static` and `extension` features, you **must** define `__loggery_extension_impl`
//! function in your binary crate, or you'll get a linker error!
//!
//! </div>
//!
//! # Features
//!
//! > **Default features:** `std`, `metadata`, `runtime_level`
//!
//! | Feature | Default | Description |
//! |-------------------|:-------:|---------------------------------------------------------------|
//! | `std` | __✓__ | Enables default stdout logger |
//! | `static` | __✗__ | Enables static extern logger definition |
//! | `static_default` | __✗__ | Provides default static logger (enables `std` + `static`) |
//! | `metadata` | __✓__ | Enables [`meta`](Metadata) field in the [`Payload`] |
//! | `extension` | __✗__ | Enables extension hooks for extra functionality |
//! | `runtime_level` | __✓__ | Allows changing log level filtering at runtime |
//! | `min_level_off` | __✗__ | Disables all logs at compile time |
//! | `min_level_trace` | __✗__ | Only logs [`trace`], [`debug`], [`info`], [`warn`], [`error`] |
//! | `min_level_debug` | __✗__ | Only logs [`debug`], [`info`], [`warn`], [`error`] |
//! | `min_level_info` | __✗__ | Only logs [`info`], [`warn`], [`error`] |
//! | `min_level_warn` | __✗__ | Only logs [`warn`], [`error`] |
//! | `min_level_error` | __✗__ | Only logs [`error`] |
/// Log levels in order of incraesing severity.
/// Extra context and information for a log.
/// The data passed to the logger and extensions.
/// Function type for custom logger implementation.
pub type LoggerFn = fn;
/// Function type for custom extension implementation.
pub type ExtensionFn = fn;
/// Compile-time minimum log level set by `min_level_*` feature flags.
///
/// If no specific level is set, all logs are enabled by default (`min_level_trace`).
const COMPILE_TIME_MIN_LEVEL: = match ;
extern "Rust"
/// Global logger function pointer storage. (NOT `static` feature)
static LOGGER_FN: AtomicPtr =
new;
/// Global extension function pointer storage. (`extension` feature, NOT `static` feature)
static EXTENSION_FN: AtomicPtr =
new;
/// Runtime minimum log level storage. (`runtime_level` feature)
static RUNTIME_MIN_LEVEL: AtomicU8 =
new;
/// Sets the global logger function. (NOT `static` feature)
///
/// It's recommended to call once during the initialization.
///
/// # Example
///
/// ```
/// use loggery::{Payload, debug};
///
/// fn my_logger(payload: Payload) {
/// // Your custom implementation
/// }
///
/// fn main() {
/// loggery::set_logger(my_logger);
///
/// debug!("A log message using my custom logger!");
/// }
/// ```
///
/// # Note
///
/// When the `static` feature is enabled, this function isn't available. Instead, you must define
/// this function in your binary crate:
///
/// ```no_run
/// use loggery::Payload;
///
/// #[no_mangle]
/// pub extern "Rust" fn __loggery_log_impl(payload: Payload) {
/// // Your custom implementation
/// }
/// ```
///
/// > **Tip:** Alternatively, use the `static_default` feature to get a default stdout logger with
/// > static dispatch (but you won't be able to define a custom `__loggery_log_impl` in that case).
///
/// When the `std` feature is enabled, a default logger is automatically initialized if no logger
/// has been set. This function can still be used to override that default.
/// Sets the global extension function. (`extension` feature, NOT `static` feature)
///
/// Extensions are called before the logger and receive a reference to the [`Payload`], giving us
/// the ability to do additional functionality like saving logs to file.
///
/// It's recommended to call once during the initialization.
///
/// # Example
///
/// ```no_run
/// use loggery::{Payload, debug};
///
/// fn my_extension(payload: &Payload) {
/// // Your custom implementation
///
/// // For example, you can use the provided extension `save_to_file`
/// let _ = loggery::extensions::save_to_file(payload, "path/to/app.log");
/// }
///
/// fn main() {
/// loggery::set_extension(my_extension);
///
/// debug!("A log message that will be saved to a file too!");
/// }
/// ```
///
/// # Note
///
/// When the `static` feature is enabled, this function isn't available. Instead, you must define
/// this function in your binary crate:
///
/// ```no_run
/// use loggery::Payload;
///
/// #[no_mangle]
/// pub extern "Rust" fn __loggery_extension_impl(payload: &Payload) {
/// // Your custom implementation
/// }
/// ```
/// Sets the runtime minimum log level. (`runtime_level` feature)
///
/// > You can also use the `min_level_*` features for compile-time level filtering.
/// > (e.g., `min_level_warn` will disable all the log levels below [`warn!`] at compile-time.)
///
/// # Note
///
/// This cannot enable levels that were filtered at compile time.
/// If compiled with feature `min_level_info`, calling `set_min_level(Level::Debug)` will have
/// no effect.
///
/// # Example
///
/// ```
/// use loggery::{Level, debug, warn};
///
/// loggery::set_min_level(Level::Warn);
///
/// debug!("This will NOT be logged");
/// warn!("This will be logged");
/// ```
/// Returns the effective minimum log level (the stricter of compile-time and runtime levels).
///
/// # Example
///
/// ```
/// use loggery::Level;
///
/// # #[cfg(feature = "runtime_level")]
/// loggery::set_min_level(Level::Debug);
///
/// # #[cfg(all(feature = "runtime_level", not(feature = "min_level_off")))]
/// assert_eq!(loggery::get_min_level(), Some(Level::Debug));
/// ```
/// Core logging entry point used internally by macros like [`debug!`] and [`error!`].
///
/// It's recommended to use the macros instead of calling directly.
/// Converts a raw pointer back to a `LoggerFn`.
///
/// # Safety
///
/// Safe only when `ptr` was created by casting a valid `LoggerFn` to `*mut ()`.
/// The caller must ensure:
/// - Pointer originated from a valid function pointer cast
/// - Fnuction pointer has 'static lifetime (guaranteed for all fn pointers)
/// - Proper synchronization (handled by atomic ops)
/// Converts a raw pointer back to an `ExtensionFn`.
///
/// # Safety
///
/// Safe only when `ptr` was created by casting a valid `ExtensionFn` to `*mut ()`.
/// The caller must ensure:
/// - Pointer originated from a valid function pointer cast
/// - Fnuction pointer has 'static lifetime (guaranteed for all fn pointers)
/// - Proper synchronization (handled by atomic ops)
/// Gets the logger, auto-initializing a default stdout logger if needed (`std` feature).
/// Returns `None` if not set and `std` feature isn't enabled.
/// Gets the extension function if one is set, otherwise returns None.
/// Logs a message at the specified level.
///
/// This is the underlying macro used by [`trace!`], [`debug!`], [`info!`], [`warn!`] and [`error!`].
/// While you mostly use those level-specific macros, `log!` can be useful when you want to specify
/// the log level dynamically or crate your own logging abstractions.
///
/// # Example
///
/// ```
/// use loggery::{Level, log};
///
/// let level = if cfg!(debug_assertions) {
/// Level::Debug
/// } else {
/// Level::Info
/// };
///
/// log!(level, "This is a log with dynamically set level")
/// ```
/// Logs a message at the specified level.
///
/// This is the underlying macro used by [`trace!`], [`debug!`], [`info!`], [`warn!`] and [`error!`].
/// While you mostly use those level-specific macros, `log!` can be useful when you want to specify
/// the log level dynamically or crate your own logging abstractions.
///
/// # Example
///
/// ```
/// use loggery::{Level, log};
///
/// let level = if cfg!(debug_assertions) {
/// Level::Debug
/// } else {
/// Level::Info
/// };
///
/// log!(level, "This is a log with dynamically set level")
/// ```
/// Logs a message at the `trace` level.
///
/// # Example
///
/// ```
/// use loggery::trace;
///
/// trace!("Entering function...");
/// ```
///
/// # Compile-time filtering
///
/// If feature `min_level_debug` or higher is enabled, this compiles to nothing in release builds
/// with optimizations.
/// Logs a message at the `debug` level.
///
/// # Example
///
/// ```
/// use loggery::debug;
///
/// let x = 69;
///
/// debug!("Variable `x` is {}", x);
/// ```
///
/// # Compile-time filtering
///
/// If feature `min_level_info` or higher is enabled, this compiles to nothing in release builds
/// with optimizations.
/// Logs a message at the `info` level.
///
/// # Example
///
/// ```
/// use loggery::info;
///
/// const PORT: u16 = 8080;
///
/// info!("Server is started on port {}", PORT);
/// ```
///
/// # Compile-time filtering
///
/// If feature `min_level_warn` or higher is enabled, this compiles to nothing in release builds
/// with optimizations.
/// Logs a message at the `warn` level.
///
/// # Example
///
/// ```
/// use loggery::warn;
///
/// warn!("Configuration file not found, using defaults");
/// ```
///
/// # Compile-time filtering
///
/// If feature `min_level_error` or higher is enabled, this compiles to nothing in release builds
/// with optimizations.
/// Logs a message at the `error` level.
///
/// # Example
///
/// ```
/// use loggery::error;
///
/// error!("Failed to connect to database!");
/// ```
///
/// # Compile-time filtering
///
/// If feature `min_level_off` or higher is enabled, this compiles to nothing in release builds
/// with optimizations.
/// Built-in extension utilities for common logging tasks.
///
/// These functions are desigend to be called from within your custom extension function.
/// They must not be passed directly to the [`set_extension`] because they might need parameters.
///
/// # Example
///
/// ```no_run
/// use loggery::{Payload, debug};
///
/// fn my_extension(payload: &Payload) {
/// // Your custom implementation
///
/// // For example, you can use the provided extension `save_to_file`
/// # #[cfg(all(feature = "extension", not(feature = "static")))]
/// let _ = loggery::extensions::save_to_file(payload, "path/to/app.log");
/// }
///
/// fn main() {
/// # #[cfg(all(feature = "extension", not(feature = "static")))]
/// loggery::set_extension(my_extension);
///
/// debug!("A log message that will be saved to a file too!");
/// }
/// ```
/// This module is included if the `static_default` feature is enabled to provide a default
/// definition for log function.