@@ -319,13 +319,11 @@ use std::error::Error as StdError;
319
319
/// [`OwnedKV`](struct.OwnedKV.html)
320
320
///
321
321
/// ```
322
- /// fn main() {
323
- /// let drain = slog::Discard;
324
- /// let _root = slog::Logger::root(
325
- /// drain,
326
- /// slog::o!("key1" => "value1", "key2" => "value2")
327
- /// );
328
- /// }
322
+ /// let drain = slog::Discard;
323
+ /// let _root = slog::Logger::root(
324
+ /// drain,
325
+ /// slog::o!("key1" => "value1", "key2" => "value2")
326
+ /// );
329
327
/// ```
330
328
#[ macro_export( local_inner_macros) ]
331
329
macro_rules! o(
@@ -511,41 +509,33 @@ macro_rules! slog_record(
511
509
/// ### Simple
512
510
///
513
511
/// ```
514
- /// use slog::info;
515
- /// fn main() {
516
- /// let drain = slog::Discard;
517
- /// let root = slog::Logger::root(
518
- /// drain,
519
- /// slog::o!("key1" => "value1", "key2" => "value2")
520
- /// );
521
- /// slog::info!(root, "test info log"; "log-key" => true);
522
- /// }
512
+ /// let drain = slog::Discard;
513
+ /// let root = slog::Logger::root(
514
+ /// drain,
515
+ /// slog::o!("key1" => "value1", "key2" => "value2"),
516
+ /// );
517
+ /// slog::info!(root, "test info log"; "log-key" => true);
523
518
/// ```
524
519
///
525
520
/// Note that `"key" => value` part is optional:
526
521
///
527
522
/// ```
528
- /// use slog::info;
529
- /// fn main() {
530
- /// let drain = slog::Discard;
531
- /// let root = slog::Logger::root(
532
- /// drain, slog::o!("key1" => "value1", "key2" => "value2")
533
- /// );
534
- /// info!(root, "test info log");
535
- /// }
523
+ /// let drain = slog::Discard;
524
+ /// let root = slog::Logger::root(
525
+ /// drain,
526
+ /// slog::o!("key1" => "value1", "key2" => "value2"),
527
+ /// );
528
+ /// slog::info!(root, "test info log");
536
529
/// ```
537
530
///
538
531
/// ### Formatting support:
539
532
///
540
533
/// ```
541
- /// use slog::info;
542
- /// fn main() {
543
- /// let drain = slog::Discard;
544
- /// let root = slog::Logger::root(drain,
545
- /// slog::o!("key1" => "value1", "key2" => "value2")
546
- /// );
547
- /// info!(root, "formatted {num_entries} entries of {}", "something", num_entries = 2; "log-key" => true);
548
- /// }
534
+ /// let drain = slog::Discard;
535
+ /// let root = slog::Logger::root(drain,
536
+ /// slog::o!("key1" => "value1", "key2" => "value2")
537
+ /// );
538
+ /// slog::info!(root, "formatted {num_entries} entries of {}", "something", num_entries = 2; "log-key" => true);
549
539
/// ```
550
540
///
551
541
/// Note:
@@ -557,14 +547,12 @@ macro_rules! slog_record(
557
547
/// `"key" => value` part is optional:
558
548
///
559
549
/// ```
560
- /// use slog::info;
561
- /// fn main() {
562
- /// let drain = slog::Discard;
563
- /// let root = slog::Logger::root(
564
- /// drain, slog::o!("key1" => "value1", "key2" => "value2")
565
- /// );
566
- /// info!(root, "formatted: {}", 1);
567
- /// }
550
+ /// let drain = slog::Discard;
551
+ /// let root = slog::Logger::root(
552
+ /// drain,
553
+ /// slog::o!("key1" => "value1", "key2" => "value2"),
554
+ /// );
555
+ /// slog::info!(root, "formatted: {}", 1);
568
556
/// ```
569
557
///
570
558
/// Use formatting support wisely. Prefer named arguments, so the associated
@@ -576,18 +564,15 @@ macro_rules! slog_record(
576
564
/// with `#`.
577
565
///
578
566
/// ```
579
- /// use slog::info;
580
- /// fn main() {
581
- /// let drain = slog::Discard;
582
- /// let root = slog::Logger::root(drain,
583
- /// slog::o!("key1" => "value1", "key2" => "value2")
584
- /// );
585
- /// let ops = 3;
586
- /// slog::info!(
587
- /// root,
588
- /// #"performance-metric", "thread speed"; "ops_per_sec" => ops
589
- /// );
590
- /// }
567
+ /// let drain = slog::Discard;
568
+ /// let root = slog::Logger::root(drain,
569
+ /// slog::o!("key1" => "value1", "key2" => "value2")
570
+ /// );
571
+ /// let ops = 3;
572
+ /// slog::info!(
573
+ /// root,
574
+ /// #"performance-metric", "thread speed"; "ops_per_sec" => ops
575
+ /// );
591
576
/// ```
592
577
///
593
578
/// See `Record::tag()` for more information about tags.
@@ -602,40 +587,30 @@ macro_rules! slog_record(
602
587
/// `=>` syntax.
603
588
///
604
589
/// ```
605
- /// use slog::*;
590
+ /// use slog::{KV, Value, Record, Serializer, Key, o, info};
591
+ /// struct MyKV;
592
+ /// struct MyV;
606
593
///
607
- /// fn main() {
608
- /// struct MyKV;
609
- /// struct MyV;
610
- ///
611
- /// impl KV for MyKV {
612
- /// fn serialize(&self,
613
- /// _record: &Record,
614
- /// serializer: &mut dyn Serializer)
615
- /// -> Result {
616
- /// serializer.emit_u32("MyK".into(), 16)
617
- /// }
594
+ /// impl KV for MyKV {
595
+ /// fn serialize(&self, _record: &Record, serializer: &mut dyn Serializer) -> slog::Result {
596
+ /// serializer.emit_u32("MyK".into(), 16)
618
597
/// }
598
+ /// }
619
599
///
620
- /// impl Value for MyV {
621
- /// fn serialize(&self,
622
- /// _record: &Record,
623
- /// key : Key,
624
- /// serializer: &mut dyn Serializer)
625
- /// -> Result {
626
- /// serializer.emit_u32("MyKV".into(), 16)
627
- /// }
600
+ /// impl Value for MyV {
601
+ /// fn serialize(&self, _record: &Record, key: Key, serializer: &mut dyn Serializer) -> slog::Result {
602
+ /// serializer.emit_u32("MyKV".into(), 16)
628
603
/// }
604
+ /// }
629
605
///
630
- /// let drain = slog::Discard;
606
+ /// let drain = slog::Discard;
631
607
///
632
- /// let root = slog::Logger::root(drain, o!(MyKV));
608
+ /// let root = slog::Logger::root(drain, o!(MyKV));
633
609
///
634
- /// info!(
635
- /// root,
636
- /// "testing MyV"; "MyV" => MyV
637
- /// );
638
- /// }
610
+ /// info!(
611
+ /// root,
612
+ /// "testing MyV"; "MyV" => MyV
613
+ /// );
639
614
/// ```
640
615
///
641
616
/// ### `fmt::Display` and `fmt::Debug` values
@@ -659,17 +634,14 @@ macro_rules! slog_record(
659
634
/// [`kv` macro](macro.log.html)
660
635
///
661
636
/// ```
662
- /// use std::fmt::Write;
663
- ///
664
- /// fn main() {
665
- /// let drain = slog::Discard;
666
- /// let log = slog::Logger::root(drain, slog::o!());
637
+ /// # use std::fmt::Write;
638
+ /// let drain = slog::Discard;
639
+ /// let log = slog::Logger::root(drain, slog::o!());
667
640
///
668
- /// let mut output = String::new();
641
+ /// let mut output = String::new();
669
642
///
670
- /// if let Err(e) = write!(&mut output, "write to string") {
671
- /// slog::error!(log, "write failed"; "err" => %e);
672
- /// }
643
+ /// if let Err(e) = write!(&mut output, "write to string") {
644
+ /// slog::error!(log, "write failed"; "err" => %e);
673
645
/// }
674
646
/// ```
675
647
#[ macro_export( local_inner_macros) ]
@@ -1007,12 +979,10 @@ where
1007
979
/// Use `o!` macro to build `OwnedKV` object.
1008
980
///
1009
981
/// ```
1010
- /// fn main() {
1011
- /// let _root = slog::Logger::root(
1012
- /// slog::Discard,
1013
- /// slog::o!("key1" => "value1", "key2" => "value2"),
1014
- /// );
1015
- /// }
982
+ /// let _root = slog::Logger::root(
983
+ /// slog::Discard,
984
+ /// slog::o!("key1" => "value1", "key2" => "value2"),
985
+ /// );
1016
986
/// ```
1017
987
pub fn root < T > ( drain : D , values : OwnedKV < T > ) -> Logger
1018
988
where
@@ -1075,12 +1045,12 @@ where
1075
1045
///
1076
1046
/// ```
1077
1047
/// use slog::o;
1078
- ///
1079
- /// fn main() {
1080
- /// let root = slog::Logger::root(slog::Discard ,
1081
- /// o!("key1" => "value1", "key2" => "value2") );
1082
- /// let _log = root.new(o!("key" => "value"));
1083
- /// }
1048
+ /// let root = slog::Logger::root(
1049
+ /// slog::Discard,
1050
+ /// o!("key1" => "value1", "key2" => "value2") ,
1051
+ /// );
1052
+ /// let _log = root.new(slog:: o!("key" => "value"));
1053
+ /// ```
1084
1054
#[ allow( clippy:: wrong_self_convention) ]
1085
1055
pub fn new < T > ( & self , values : OwnedKV < T > ) -> Logger < D >
1086
1056
where
@@ -1301,11 +1271,8 @@ pub trait Drain {
1301
1271
/// into another `Drain`.
1302
1272
///
1303
1273
/// ```
1304
- /// use slog::*;
1305
- ///
1306
- /// fn main() {
1307
- /// let _drain = Discard.map(Fuse);
1308
- /// }
1274
+ /// use slog::{Discard, Fuse, Drain, o};
1275
+ /// let _drain = Discard.map(Fuse);
1309
1276
/// ```
1310
1277
fn map < F , R > ( self , f : F ) -> R
1311
1278
where
@@ -3257,23 +3224,20 @@ impl Drop for PushFnValueSerializer<'_> {
3257
3224
///
3258
3225
/// ```
3259
3226
/// use slog::{PushFnValue, Logger, Discard};
3260
- ///
3261
- /// fn main() {
3262
- /// // Create a logger with a key-value printing
3263
- /// // `file:line` string value for every logging statement.
3264
- /// // `Discard` `Drain` used for brevity.
3265
- /// let root = Logger::root(Discard, slog::o!(
3266
- /// "source_location" => PushFnValue(|record , s| {
3267
- /// s.serialize(
3268
- /// format_args!(
3269
- /// "{}:{}",
3270
- /// record.file(),
3271
- /// record.line(),
3272
- /// )
3273
- /// )
3274
- /// })
3275
- /// ));
3276
- /// }
3227
+ /// // Create a logger with a key-value printing
3228
+ /// // `file:line` string value for every logging statement.
3229
+ /// // `Discard` `Drain` used for brevity.
3230
+ /// let root = Logger::root(Discard, slog::o!(
3231
+ /// "source_location" => PushFnValue(|record , s| {
3232
+ /// s.serialize(
3233
+ /// format_args!(
3234
+ /// "{}:{}",
3235
+ /// record.file(),
3236
+ /// record.line(),
3237
+ /// )
3238
+ /// )
3239
+ /// })
3240
+ /// ));
3277
3241
/// ```
3278
3242
#[ must_use = "must be passed to logger to actually log" ]
3279
3243
pub struct PushFnValue < F > ( pub F )
0 commit comments