2011 lines
192 KiB
HTML
2011 lines
192 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/log-0.4.29/src/lib.rs`."><title>lib.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="log" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="icon" href="https://prev.rust-lang.org/favicon.ico"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">log/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-4"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
|
|
<a href=#2 id=2 data-nosnippet>2</a>// file at the top-level directory of this distribution and at
|
|
<a href=#3 id=3 data-nosnippet>3</a>// http://rust-lang.org/COPYRIGHT.
|
|
<a href=#4 id=4 data-nosnippet>4</a>//
|
|
<a href=#5 id=5 data-nosnippet>5</a>// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
<a href=#6 id=6 data-nosnippet>6</a>// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
<a href=#7 id=7 data-nosnippet>7</a>// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
<a href=#8 id=8 data-nosnippet>8</a>// option. This file may not be copied, modified, or distributed
|
|
<a href=#9 id=9 data-nosnippet>9</a>// except according to those terms.
|
|
<a href=#10 id=10 data-nosnippet>10</a>
|
|
<a href=#11 id=11 data-nosnippet>11</a></span><span class="doccomment">//! A lightweight logging facade.
|
|
<a href=#12 id=12 data-nosnippet>12</a>//!
|
|
<a href=#13 id=13 data-nosnippet>13</a>//! The `log` crate provides a single logging API that abstracts over the
|
|
<a href=#14 id=14 data-nosnippet>14</a>//! actual logging implementation. Libraries can use the logging API provided
|
|
<a href=#15 id=15 data-nosnippet>15</a>//! by this crate, and the consumer of those libraries can choose the logging
|
|
<a href=#16 id=16 data-nosnippet>16</a>//! implementation that is most suitable for its use case.
|
|
<a href=#17 id=17 data-nosnippet>17</a>//!
|
|
<a href=#18 id=18 data-nosnippet>18</a>//! If no logging implementation is selected, the facade falls back to a "noop"
|
|
<a href=#19 id=19 data-nosnippet>19</a>//! implementation that ignores all log messages. The overhead in this case
|
|
<a href=#20 id=20 data-nosnippet>20</a>//! is very small - just an integer load, comparison and jump.
|
|
<a href=#21 id=21 data-nosnippet>21</a>//!
|
|
<a href=#22 id=22 data-nosnippet>22</a>//! A log request consists of a _target_, a _level_, and a _body_. A target is a
|
|
<a href=#23 id=23 data-nosnippet>23</a>//! string which defaults to the module path of the location of the log request,
|
|
<a href=#24 id=24 data-nosnippet>24</a>//! though that default may be overridden. Logger implementations typically use
|
|
<a href=#25 id=25 data-nosnippet>25</a>//! the target to filter requests based on some user configuration.
|
|
<a href=#26 id=26 data-nosnippet>26</a>//!
|
|
<a href=#27 id=27 data-nosnippet>27</a>//! # Usage
|
|
<a href=#28 id=28 data-nosnippet>28</a>//!
|
|
<a href=#29 id=29 data-nosnippet>29</a>//! The basic use of the log crate is through the five logging macros: [`error!`],
|
|
<a href=#30 id=30 data-nosnippet>30</a>//! [`warn!`], [`info!`], [`debug!`] and [`trace!`]
|
|
<a href=#31 id=31 data-nosnippet>31</a>//! where `error!` represents the highest-priority log messages
|
|
<a href=#32 id=32 data-nosnippet>32</a>//! and `trace!` the lowest. The log messages are filtered by configuring
|
|
<a href=#33 id=33 data-nosnippet>33</a>//! the log level to exclude messages with a lower priority.
|
|
<a href=#34 id=34 data-nosnippet>34</a>//! Each of these macros accept format strings similarly to [`println!`].
|
|
<a href=#35 id=35 data-nosnippet>35</a>//!
|
|
<a href=#36 id=36 data-nosnippet>36</a>//!
|
|
<a href=#37 id=37 data-nosnippet>37</a>//! [`error!`]: ./macro.error.html
|
|
<a href=#38 id=38 data-nosnippet>38</a>//! [`warn!`]: ./macro.warn.html
|
|
<a href=#39 id=39 data-nosnippet>39</a>//! [`info!`]: ./macro.info.html
|
|
<a href=#40 id=40 data-nosnippet>40</a>//! [`debug!`]: ./macro.debug.html
|
|
<a href=#41 id=41 data-nosnippet>41</a>//! [`trace!`]: ./macro.trace.html
|
|
<a href=#42 id=42 data-nosnippet>42</a>//! [`println!`]: https://doc.rust-lang.org/stable/std/macro.println.html
|
|
<a href=#43 id=43 data-nosnippet>43</a>//!
|
|
<a href=#44 id=44 data-nosnippet>44</a>//! Avoid writing expressions with side-effects in log statements. They may not be evaluated.
|
|
<a href=#45 id=45 data-nosnippet>45</a>//!
|
|
<a href=#46 id=46 data-nosnippet>46</a>//! ## In libraries
|
|
<a href=#47 id=47 data-nosnippet>47</a>//!
|
|
<a href=#48 id=48 data-nosnippet>48</a>//! Libraries should link only to the `log` crate, and use the provided
|
|
<a href=#49 id=49 data-nosnippet>49</a>//! macros to log whatever information will be useful to downstream consumers.
|
|
<a href=#50 id=50 data-nosnippet>50</a>//!
|
|
<a href=#51 id=51 data-nosnippet>51</a>//! ### Examples
|
|
<a href=#52 id=52 data-nosnippet>52</a>//!
|
|
<a href=#53 id=53 data-nosnippet>53</a>//! ```
|
|
<a href=#54 id=54 data-nosnippet>54</a>//! # #[derive(Debug)] pub struct Yak(String);
|
|
<a href=#55 id=55 data-nosnippet>55</a>//! # impl Yak { fn shave(&mut self, _: u32) {} }
|
|
<a href=#56 id=56 data-nosnippet>56</a>//! # fn find_a_razor() -> Result<u32, u32> { Ok(1) }
|
|
<a href=#57 id=57 data-nosnippet>57</a>//! use log::{info, warn};
|
|
<a href=#58 id=58 data-nosnippet>58</a>//!
|
|
<a href=#59 id=59 data-nosnippet>59</a>//! pub fn shave_the_yak(yak: &mut Yak) {
|
|
<a href=#60 id=60 data-nosnippet>60</a>//! info!(target: "yak_events", "Commencing yak shaving for {yak:?}");
|
|
<a href=#61 id=61 data-nosnippet>61</a>//!
|
|
<a href=#62 id=62 data-nosnippet>62</a>//! loop {
|
|
<a href=#63 id=63 data-nosnippet>63</a>//! match find_a_razor() {
|
|
<a href=#64 id=64 data-nosnippet>64</a>//! Ok(razor) => {
|
|
<a href=#65 id=65 data-nosnippet>65</a>//! info!("Razor located: {razor}");
|
|
<a href=#66 id=66 data-nosnippet>66</a>//! yak.shave(razor);
|
|
<a href=#67 id=67 data-nosnippet>67</a>//! break;
|
|
<a href=#68 id=68 data-nosnippet>68</a>//! }
|
|
<a href=#69 id=69 data-nosnippet>69</a>//! Err(err) => {
|
|
<a href=#70 id=70 data-nosnippet>70</a>//! warn!("Unable to locate a razor: {err}, retrying");
|
|
<a href=#71 id=71 data-nosnippet>71</a>//! }
|
|
<a href=#72 id=72 data-nosnippet>72</a>//! }
|
|
<a href=#73 id=73 data-nosnippet>73</a>//! }
|
|
<a href=#74 id=74 data-nosnippet>74</a>//! }
|
|
<a href=#75 id=75 data-nosnippet>75</a>//! # fn main() {}
|
|
<a href=#76 id=76 data-nosnippet>76</a>//! ```
|
|
<a href=#77 id=77 data-nosnippet>77</a>//!
|
|
<a href=#78 id=78 data-nosnippet>78</a>//! ## In executables
|
|
<a href=#79 id=79 data-nosnippet>79</a>//!
|
|
<a href=#80 id=80 data-nosnippet>80</a>//! Executables should choose a logging implementation and initialize it early in the
|
|
<a href=#81 id=81 data-nosnippet>81</a>//! runtime of the program. Logging implementations will typically include a
|
|
<a href=#82 id=82 data-nosnippet>82</a>//! function to do this. Any log messages generated before
|
|
<a href=#83 id=83 data-nosnippet>83</a>//! the implementation is initialized will be ignored.
|
|
<a href=#84 id=84 data-nosnippet>84</a>//!
|
|
<a href=#85 id=85 data-nosnippet>85</a>//! The executable itself may use the `log` crate to log as well.
|
|
<a href=#86 id=86 data-nosnippet>86</a>//!
|
|
<a href=#87 id=87 data-nosnippet>87</a>//! ### Warning
|
|
<a href=#88 id=88 data-nosnippet>88</a>//!
|
|
<a href=#89 id=89 data-nosnippet>89</a>//! The logging system may only be initialized once.
|
|
<a href=#90 id=90 data-nosnippet>90</a>//!
|
|
<a href=#91 id=91 data-nosnippet>91</a>//! ## Structured logging
|
|
<a href=#92 id=92 data-nosnippet>92</a>//!
|
|
<a href=#93 id=93 data-nosnippet>93</a>//! If you enable the `kv` feature you can associate structured values
|
|
<a href=#94 id=94 data-nosnippet>94</a>//! with your log records. If we take the example from before, we can include
|
|
<a href=#95 id=95 data-nosnippet>95</a>//! some additional context besides what's in the formatted message:
|
|
<a href=#96 id=96 data-nosnippet>96</a>//!
|
|
<a href=#97 id=97 data-nosnippet>97</a>//! ```
|
|
<a href=#98 id=98 data-nosnippet>98</a>//! # use serde::Serialize;
|
|
<a href=#99 id=99 data-nosnippet>99</a>//! # #[derive(Debug, Serialize)] pub struct Yak(String);
|
|
<a href=#100 id=100 data-nosnippet>100</a>//! # impl Yak { fn shave(&mut self, _: u32) {} }
|
|
<a href=#101 id=101 data-nosnippet>101</a>//! # fn find_a_razor() -> Result<u32, std::io::Error> { Ok(1) }
|
|
<a href=#102 id=102 data-nosnippet>102</a>//! # #[cfg(feature = "kv_serde")]
|
|
<a href=#103 id=103 data-nosnippet>103</a>//! # fn main() {
|
|
<a href=#104 id=104 data-nosnippet>104</a>//! use log::{info, warn};
|
|
<a href=#105 id=105 data-nosnippet>105</a>//!
|
|
<a href=#106 id=106 data-nosnippet>106</a>//! pub fn shave_the_yak(yak: &mut Yak) {
|
|
<a href=#107 id=107 data-nosnippet>107</a>//! info!(target: "yak_events", yak:serde; "Commencing yak shaving");
|
|
<a href=#108 id=108 data-nosnippet>108</a>//!
|
|
<a href=#109 id=109 data-nosnippet>109</a>//! loop {
|
|
<a href=#110 id=110 data-nosnippet>110</a>//! match find_a_razor() {
|
|
<a href=#111 id=111 data-nosnippet>111</a>//! Ok(razor) => {
|
|
<a href=#112 id=112 data-nosnippet>112</a>//! info!(razor; "Razor located");
|
|
<a href=#113 id=113 data-nosnippet>113</a>//! yak.shave(razor);
|
|
<a href=#114 id=114 data-nosnippet>114</a>//! break;
|
|
<a href=#115 id=115 data-nosnippet>115</a>//! }
|
|
<a href=#116 id=116 data-nosnippet>116</a>//! Err(e) => {
|
|
<a href=#117 id=117 data-nosnippet>117</a>//! warn!(e:err; "Unable to locate a razor, retrying");
|
|
<a href=#118 id=118 data-nosnippet>118</a>//! }
|
|
<a href=#119 id=119 data-nosnippet>119</a>//! }
|
|
<a href=#120 id=120 data-nosnippet>120</a>//! }
|
|
<a href=#121 id=121 data-nosnippet>121</a>//! }
|
|
<a href=#122 id=122 data-nosnippet>122</a>//! # }
|
|
<a href=#123 id=123 data-nosnippet>123</a>//! # #[cfg(not(feature = "kv_serde"))]
|
|
<a href=#124 id=124 data-nosnippet>124</a>//! # fn main() {}
|
|
<a href=#125 id=125 data-nosnippet>125</a>//! ```
|
|
<a href=#126 id=126 data-nosnippet>126</a>//!
|
|
<a href=#127 id=127 data-nosnippet>127</a>//! See the [`kv`] module documentation for more details.
|
|
<a href=#128 id=128 data-nosnippet>128</a>//!
|
|
<a href=#129 id=129 data-nosnippet>129</a>//! # Available logging implementations
|
|
<a href=#130 id=130 data-nosnippet>130</a>//!
|
|
<a href=#131 id=131 data-nosnippet>131</a>//! In order to produce log output executables have to use
|
|
<a href=#132 id=132 data-nosnippet>132</a>//! a logger implementation compatible with the facade.
|
|
<a href=#133 id=133 data-nosnippet>133</a>//! There are many available implementations to choose from,
|
|
<a href=#134 id=134 data-nosnippet>134</a>//! here are some of the most popular ones:
|
|
<a href=#135 id=135 data-nosnippet>135</a>//!
|
|
<a href=#136 id=136 data-nosnippet>136</a>//! * Simple minimal loggers:
|
|
<a href=#137 id=137 data-nosnippet>137</a>//! * [env_logger]
|
|
<a href=#138 id=138 data-nosnippet>138</a>//! * [colog]
|
|
<a href=#139 id=139 data-nosnippet>139</a>//! * [simple_logger]
|
|
<a href=#140 id=140 data-nosnippet>140</a>//! * [simplelog]
|
|
<a href=#141 id=141 data-nosnippet>141</a>//! * [pretty_env_logger]
|
|
<a href=#142 id=142 data-nosnippet>142</a>//! * [stderrlog]
|
|
<a href=#143 id=143 data-nosnippet>143</a>//! * [flexi_logger]
|
|
<a href=#144 id=144 data-nosnippet>144</a>//! * [call_logger]
|
|
<a href=#145 id=145 data-nosnippet>145</a>//! * [std-logger]
|
|
<a href=#146 id=146 data-nosnippet>146</a>//! * [structured-logger]
|
|
<a href=#147 id=147 data-nosnippet>147</a>//! * [clang_log]
|
|
<a href=#148 id=148 data-nosnippet>148</a>//! * [ftail]
|
|
<a href=#149 id=149 data-nosnippet>149</a>//! * Complex configurable frameworks:
|
|
<a href=#150 id=150 data-nosnippet>150</a>//! * [log4rs]
|
|
<a href=#151 id=151 data-nosnippet>151</a>//! * [logforth]
|
|
<a href=#152 id=152 data-nosnippet>152</a>//! * [fern]
|
|
<a href=#153 id=153 data-nosnippet>153</a>//! * [spdlog-rs]
|
|
<a href=#154 id=154 data-nosnippet>154</a>//! * Adaptors for other facilities:
|
|
<a href=#155 id=155 data-nosnippet>155</a>//! * [syslog]
|
|
<a href=#156 id=156 data-nosnippet>156</a>//! * [slog-stdlog]
|
|
<a href=#157 id=157 data-nosnippet>157</a>//! * [systemd-journal-logger]
|
|
<a href=#158 id=158 data-nosnippet>158</a>//! * [android_log]
|
|
<a href=#159 id=159 data-nosnippet>159</a>//! * [win_dbg_logger]
|
|
<a href=#160 id=160 data-nosnippet>160</a>//! * [db_logger]
|
|
<a href=#161 id=161 data-nosnippet>161</a>//! * [log-to-defmt]
|
|
<a href=#162 id=162 data-nosnippet>162</a>//! * [logcontrol-log]
|
|
<a href=#163 id=163 data-nosnippet>163</a>//! * For WebAssembly binaries:
|
|
<a href=#164 id=164 data-nosnippet>164</a>//! * [console_log]
|
|
<a href=#165 id=165 data-nosnippet>165</a>//! * For dynamic libraries:
|
|
<a href=#166 id=166 data-nosnippet>166</a>//! * You may need to construct an FFI-safe wrapper over `log` to initialize in your libraries
|
|
<a href=#167 id=167 data-nosnippet>167</a>//! * Utilities:
|
|
<a href=#168 id=168 data-nosnippet>168</a>//! * [log_err]
|
|
<a href=#169 id=169 data-nosnippet>169</a>//! * [log-reload]
|
|
<a href=#170 id=170 data-nosnippet>170</a>//! * [alterable_logger]
|
|
<a href=#171 id=171 data-nosnippet>171</a>//!
|
|
<a href=#172 id=172 data-nosnippet>172</a>//! # Implementing a Logger
|
|
<a href=#173 id=173 data-nosnippet>173</a>//!
|
|
<a href=#174 id=174 data-nosnippet>174</a>//! Loggers implement the [`Log`] trait. Here's a very basic example that simply
|
|
<a href=#175 id=175 data-nosnippet>175</a>//! logs all messages at the [`Error`][level_link], [`Warn`][level_link] or
|
|
<a href=#176 id=176 data-nosnippet>176</a>//! [`Info`][level_link] levels to stdout:
|
|
<a href=#177 id=177 data-nosnippet>177</a>//!
|
|
<a href=#178 id=178 data-nosnippet>178</a>//! ```
|
|
<a href=#179 id=179 data-nosnippet>179</a>//! use log::{Record, Level, Metadata};
|
|
<a href=#180 id=180 data-nosnippet>180</a>//!
|
|
<a href=#181 id=181 data-nosnippet>181</a>//! struct SimpleLogger;
|
|
<a href=#182 id=182 data-nosnippet>182</a>//!
|
|
<a href=#183 id=183 data-nosnippet>183</a>//! impl log::Log for SimpleLogger {
|
|
<a href=#184 id=184 data-nosnippet>184</a>//! fn enabled(&self, metadata: &Metadata) -> bool {
|
|
<a href=#185 id=185 data-nosnippet>185</a>//! metadata.level() <= Level::Info
|
|
<a href=#186 id=186 data-nosnippet>186</a>//! }
|
|
<a href=#187 id=187 data-nosnippet>187</a>//!
|
|
<a href=#188 id=188 data-nosnippet>188</a>//! fn log(&self, record: &Record) {
|
|
<a href=#189 id=189 data-nosnippet>189</a>//! if self.enabled(record.metadata()) {
|
|
<a href=#190 id=190 data-nosnippet>190</a>//! println!("{} - {}", record.level(), record.args());
|
|
<a href=#191 id=191 data-nosnippet>191</a>//! }
|
|
<a href=#192 id=192 data-nosnippet>192</a>//! }
|
|
<a href=#193 id=193 data-nosnippet>193</a>//!
|
|
<a href=#194 id=194 data-nosnippet>194</a>//! fn flush(&self) {}
|
|
<a href=#195 id=195 data-nosnippet>195</a>//! }
|
|
<a href=#196 id=196 data-nosnippet>196</a>//!
|
|
<a href=#197 id=197 data-nosnippet>197</a>//! # fn main() {}
|
|
<a href=#198 id=198 data-nosnippet>198</a>//! ```
|
|
<a href=#199 id=199 data-nosnippet>199</a>//!
|
|
<a href=#200 id=200 data-nosnippet>200</a>//! Loggers are installed by calling the [`set_logger`] function. The maximum
|
|
<a href=#201 id=201 data-nosnippet>201</a>//! log level also needs to be adjusted via the [`set_max_level`] function. The
|
|
<a href=#202 id=202 data-nosnippet>202</a>//! logging facade uses this as an optimization to improve performance of log
|
|
<a href=#203 id=203 data-nosnippet>203</a>//! messages at levels that are disabled. It's important to set it, as it
|
|
<a href=#204 id=204 data-nosnippet>204</a>//! defaults to [`Off`][filter_link], so no log messages will ever be captured!
|
|
<a href=#205 id=205 data-nosnippet>205</a>//! In the case of our example logger, we'll want to set the maximum log level
|
|
<a href=#206 id=206 data-nosnippet>206</a>//! to [`Info`][filter_link], since we ignore any [`Debug`][level_link] or
|
|
<a href=#207 id=207 data-nosnippet>207</a>//! [`Trace`][level_link] level log messages. A logging implementation should
|
|
<a href=#208 id=208 data-nosnippet>208</a>//! provide a function that wraps a call to [`set_logger`] and
|
|
<a href=#209 id=209 data-nosnippet>209</a>//! [`set_max_level`], handling initialization of the logger:
|
|
<a href=#210 id=210 data-nosnippet>210</a>//!
|
|
<a href=#211 id=211 data-nosnippet>211</a>//! ```
|
|
<a href=#212 id=212 data-nosnippet>212</a>//! # use log::{Level, Metadata};
|
|
<a href=#213 id=213 data-nosnippet>213</a>//! # struct SimpleLogger;
|
|
<a href=#214 id=214 data-nosnippet>214</a>//! # impl log::Log for SimpleLogger {
|
|
<a href=#215 id=215 data-nosnippet>215</a>//! # fn enabled(&self, _: &Metadata) -> bool { false }
|
|
<a href=#216 id=216 data-nosnippet>216</a>//! # fn log(&self, _: &log::Record) {}
|
|
<a href=#217 id=217 data-nosnippet>217</a>//! # fn flush(&self) {}
|
|
<a href=#218 id=218 data-nosnippet>218</a>//! # }
|
|
<a href=#219 id=219 data-nosnippet>219</a>//! # fn main() {}
|
|
<a href=#220 id=220 data-nosnippet>220</a>//! use log::{SetLoggerError, LevelFilter};
|
|
<a href=#221 id=221 data-nosnippet>221</a>//!
|
|
<a href=#222 id=222 data-nosnippet>222</a>//! static LOGGER: SimpleLogger = SimpleLogger;
|
|
<a href=#223 id=223 data-nosnippet>223</a>//!
|
|
<a href=#224 id=224 data-nosnippet>224</a>//! pub fn init() -> Result<(), SetLoggerError> {
|
|
<a href=#225 id=225 data-nosnippet>225</a>//! log::set_logger(&LOGGER)
|
|
<a href=#226 id=226 data-nosnippet>226</a>//! .map(|()| log::set_max_level(LevelFilter::Info))
|
|
<a href=#227 id=227 data-nosnippet>227</a>//! }
|
|
<a href=#228 id=228 data-nosnippet>228</a>//! ```
|
|
<a href=#229 id=229 data-nosnippet>229</a>//!
|
|
<a href=#230 id=230 data-nosnippet>230</a>//! Implementations that adjust their configurations at runtime should take care
|
|
<a href=#231 id=231 data-nosnippet>231</a>//! to adjust the maximum log level as well.
|
|
<a href=#232 id=232 data-nosnippet>232</a>//!
|
|
<a href=#233 id=233 data-nosnippet>233</a>//! # Use with `std`
|
|
<a href=#234 id=234 data-nosnippet>234</a>//!
|
|
<a href=#235 id=235 data-nosnippet>235</a>//! `set_logger` requires you to provide a `&'static Log`, which can be hard to
|
|
<a href=#236 id=236 data-nosnippet>236</a>//! obtain if your logger depends on some runtime configuration. The
|
|
<a href=#237 id=237 data-nosnippet>237</a>//! `set_boxed_logger` function is available with the `std` Cargo feature. It is
|
|
<a href=#238 id=238 data-nosnippet>238</a>//! identical to `set_logger` except that it takes a `Box<Log>` rather than a
|
|
<a href=#239 id=239 data-nosnippet>239</a>//! `&'static Log`:
|
|
<a href=#240 id=240 data-nosnippet>240</a>//!
|
|
<a href=#241 id=241 data-nosnippet>241</a>//! ```
|
|
<a href=#242 id=242 data-nosnippet>242</a>//! # use log::{Level, LevelFilter, Log, SetLoggerError, Metadata};
|
|
<a href=#243 id=243 data-nosnippet>243</a>//! # struct SimpleLogger;
|
|
<a href=#244 id=244 data-nosnippet>244</a>//! # impl log::Log for SimpleLogger {
|
|
<a href=#245 id=245 data-nosnippet>245</a>//! # fn enabled(&self, _: &Metadata) -> bool { false }
|
|
<a href=#246 id=246 data-nosnippet>246</a>//! # fn log(&self, _: &log::Record) {}
|
|
<a href=#247 id=247 data-nosnippet>247</a>//! # fn flush(&self) {}
|
|
<a href=#248 id=248 data-nosnippet>248</a>//! # }
|
|
<a href=#249 id=249 data-nosnippet>249</a>//! # fn main() {}
|
|
<a href=#250 id=250 data-nosnippet>250</a>//! # #[cfg(feature = "std")]
|
|
<a href=#251 id=251 data-nosnippet>251</a>//! pub fn init() -> Result<(), SetLoggerError> {
|
|
<a href=#252 id=252 data-nosnippet>252</a>//! log::set_boxed_logger(Box::new(SimpleLogger))
|
|
<a href=#253 id=253 data-nosnippet>253</a>//! .map(|()| log::set_max_level(LevelFilter::Info))
|
|
<a href=#254 id=254 data-nosnippet>254</a>//! }
|
|
<a href=#255 id=255 data-nosnippet>255</a>//! ```
|
|
<a href=#256 id=256 data-nosnippet>256</a>//!
|
|
<a href=#257 id=257 data-nosnippet>257</a>//! # Compile time filters
|
|
<a href=#258 id=258 data-nosnippet>258</a>//!
|
|
<a href=#259 id=259 data-nosnippet>259</a>//! Log levels can be statically disabled at compile time by enabling one of these Cargo features:
|
|
<a href=#260 id=260 data-nosnippet>260</a>//!
|
|
<a href=#261 id=261 data-nosnippet>261</a>//! * `max_level_off`
|
|
<a href=#262 id=262 data-nosnippet>262</a>//! * `max_level_error`
|
|
<a href=#263 id=263 data-nosnippet>263</a>//! * `max_level_warn`
|
|
<a href=#264 id=264 data-nosnippet>264</a>//! * `max_level_info`
|
|
<a href=#265 id=265 data-nosnippet>265</a>//! * `max_level_debug`
|
|
<a href=#266 id=266 data-nosnippet>266</a>//! * `max_level_trace`
|
|
<a href=#267 id=267 data-nosnippet>267</a>//!
|
|
<a href=#268 id=268 data-nosnippet>268</a>//! Log invocations at disabled levels will be skipped and will not even be present in the
|
|
<a href=#269 id=269 data-nosnippet>269</a>//! resulting binary. These features control the value of the `STATIC_MAX_LEVEL` constant. The
|
|
<a href=#270 id=270 data-nosnippet>270</a>//! logging macros check this value before logging a message. By default, no levels are disabled.
|
|
<a href=#271 id=271 data-nosnippet>271</a>//!
|
|
<a href=#272 id=272 data-nosnippet>272</a>//! It is possible to override this level for release builds only with the following features:
|
|
<a href=#273 id=273 data-nosnippet>273</a>//!
|
|
<a href=#274 id=274 data-nosnippet>274</a>//! * `release_max_level_off`
|
|
<a href=#275 id=275 data-nosnippet>275</a>//! * `release_max_level_error`
|
|
<a href=#276 id=276 data-nosnippet>276</a>//! * `release_max_level_warn`
|
|
<a href=#277 id=277 data-nosnippet>277</a>//! * `release_max_level_info`
|
|
<a href=#278 id=278 data-nosnippet>278</a>//! * `release_max_level_debug`
|
|
<a href=#279 id=279 data-nosnippet>279</a>//! * `release_max_level_trace`
|
|
<a href=#280 id=280 data-nosnippet>280</a>//!
|
|
<a href=#281 id=281 data-nosnippet>281</a>//! Libraries should avoid using the max level features because they're global and can't be changed
|
|
<a href=#282 id=282 data-nosnippet>282</a>//! once they're set.
|
|
<a href=#283 id=283 data-nosnippet>283</a>//!
|
|
<a href=#284 id=284 data-nosnippet>284</a>//! For example, a crate can disable trace level logs in debug builds and trace, debug, and info
|
|
<a href=#285 id=285 data-nosnippet>285</a>//! level logs in release builds with the following configuration:
|
|
<a href=#286 id=286 data-nosnippet>286</a>//!
|
|
<a href=#287 id=287 data-nosnippet>287</a>//! ```toml
|
|
<a href=#288 id=288 data-nosnippet>288</a>//! [dependencies]
|
|
<a href=#289 id=289 data-nosnippet>289</a>//! log = { version = "0.4", features = ["max_level_debug", "release_max_level_warn"] }
|
|
<a href=#290 id=290 data-nosnippet>290</a>//! ```
|
|
<a href=#291 id=291 data-nosnippet>291</a>//! # Crate Feature Flags
|
|
<a href=#292 id=292 data-nosnippet>292</a>//!
|
|
<a href=#293 id=293 data-nosnippet>293</a>//! The following crate feature flags are available in addition to the filters. They are
|
|
<a href=#294 id=294 data-nosnippet>294</a>//! configured in your `Cargo.toml`.
|
|
<a href=#295 id=295 data-nosnippet>295</a>//!
|
|
<a href=#296 id=296 data-nosnippet>296</a>//! * `std` allows use of `std` crate instead of the default `core`. Enables using `std::error` and
|
|
<a href=#297 id=297 data-nosnippet>297</a>//! `set_boxed_logger` functionality.
|
|
<a href=#298 id=298 data-nosnippet>298</a>//! * `serde` enables support for serialization and deserialization of `Level` and `LevelFilter`.
|
|
<a href=#299 id=299 data-nosnippet>299</a>//!
|
|
<a href=#300 id=300 data-nosnippet>300</a>//! ```toml
|
|
<a href=#301 id=301 data-nosnippet>301</a>//! [dependencies]
|
|
<a href=#302 id=302 data-nosnippet>302</a>//! log = { version = "0.4", features = ["std", "serde"] }
|
|
<a href=#303 id=303 data-nosnippet>303</a>//! ```
|
|
<a href=#304 id=304 data-nosnippet>304</a>//!
|
|
<a href=#305 id=305 data-nosnippet>305</a>//! # Version compatibility
|
|
<a href=#306 id=306 data-nosnippet>306</a>//!
|
|
<a href=#307 id=307 data-nosnippet>307</a>//! The 0.3 and 0.4 versions of the `log` crate are almost entirely compatible. Log messages
|
|
<a href=#308 id=308 data-nosnippet>308</a>//! made using `log` 0.3 will forward transparently to a logger implementation using `log` 0.4. Log
|
|
<a href=#309 id=309 data-nosnippet>309</a>//! messages made using `log` 0.4 will forward to a logger implementation using `log` 0.3, but the
|
|
<a href=#310 id=310 data-nosnippet>310</a>//! module path and file name information associated with the message will unfortunately be lost.
|
|
<a href=#311 id=311 data-nosnippet>311</a>//!
|
|
<a href=#312 id=312 data-nosnippet>312</a>//! [`Log`]: trait.Log.html
|
|
<a href=#313 id=313 data-nosnippet>313</a>//! [level_link]: enum.Level.html
|
|
<a href=#314 id=314 data-nosnippet>314</a>//! [filter_link]: enum.LevelFilter.html
|
|
<a href=#315 id=315 data-nosnippet>315</a>//! [`set_logger`]: fn.set_logger.html
|
|
<a href=#316 id=316 data-nosnippet>316</a>//! [`set_max_level`]: fn.set_max_level.html
|
|
<a href=#317 id=317 data-nosnippet>317</a>//! [`try_set_logger_raw`]: fn.try_set_logger_raw.html
|
|
<a href=#318 id=318 data-nosnippet>318</a>//! [`shutdown_logger_raw`]: fn.shutdown_logger_raw.html
|
|
<a href=#319 id=319 data-nosnippet>319</a>//! [env_logger]: https://docs.rs/env_logger/*/env_logger/
|
|
<a href=#320 id=320 data-nosnippet>320</a>//! [colog]: https://docs.rs/colog/*/colog/
|
|
<a href=#321 id=321 data-nosnippet>321</a>//! [simple_logger]: https://github.com/borntyping/rust-simple_logger
|
|
<a href=#322 id=322 data-nosnippet>322</a>//! [simplelog]: https://github.com/drakulix/simplelog.rs
|
|
<a href=#323 id=323 data-nosnippet>323</a>//! [pretty_env_logger]: https://docs.rs/pretty_env_logger/*/pretty_env_logger/
|
|
<a href=#324 id=324 data-nosnippet>324</a>//! [stderrlog]: https://docs.rs/stderrlog/*/stderrlog/
|
|
<a href=#325 id=325 data-nosnippet>325</a>//! [flexi_logger]: https://docs.rs/flexi_logger/*/flexi_logger/
|
|
<a href=#326 id=326 data-nosnippet>326</a>//! [call_logger]: https://docs.rs/call_logger/*/call_logger/
|
|
<a href=#327 id=327 data-nosnippet>327</a>//! [std-logger]: https://docs.rs/std-logger/*/std_logger/
|
|
<a href=#328 id=328 data-nosnippet>328</a>//! [syslog]: https://docs.rs/syslog/*/syslog/
|
|
<a href=#329 id=329 data-nosnippet>329</a>//! [slog-stdlog]: https://docs.rs/slog-stdlog/*/slog_stdlog/
|
|
<a href=#330 id=330 data-nosnippet>330</a>//! [log4rs]: https://docs.rs/log4rs/*/log4rs/
|
|
<a href=#331 id=331 data-nosnippet>331</a>//! [logforth]: https://docs.rs/logforth/*/logforth/
|
|
<a href=#332 id=332 data-nosnippet>332</a>//! [fern]: https://docs.rs/fern/*/fern/
|
|
<a href=#333 id=333 data-nosnippet>333</a>//! [spdlog-rs]: https://docs.rs/spdlog-rs/*/spdlog/
|
|
<a href=#334 id=334 data-nosnippet>334</a>//! [systemd-journal-logger]: https://docs.rs/systemd-journal-logger/*/systemd_journal_logger/
|
|
<a href=#335 id=335 data-nosnippet>335</a>//! [android_log]: https://docs.rs/android_log/*/android_log/
|
|
<a href=#336 id=336 data-nosnippet>336</a>//! [win_dbg_logger]: https://docs.rs/win_dbg_logger/*/win_dbg_logger/
|
|
<a href=#337 id=337 data-nosnippet>337</a>//! [db_logger]: https://docs.rs/db_logger/*/db_logger/
|
|
<a href=#338 id=338 data-nosnippet>338</a>//! [log-to-defmt]: https://docs.rs/log-to-defmt/*/log_to_defmt/
|
|
<a href=#339 id=339 data-nosnippet>339</a>//! [console_log]: https://docs.rs/console_log/*/console_log/
|
|
<a href=#340 id=340 data-nosnippet>340</a>//! [structured-logger]: https://docs.rs/structured-logger/latest/structured_logger/
|
|
<a href=#341 id=341 data-nosnippet>341</a>//! [logcontrol-log]: https://docs.rs/logcontrol-log/*/logcontrol_log/
|
|
<a href=#342 id=342 data-nosnippet>342</a>//! [log_err]: https://docs.rs/log_err/*/log_err/
|
|
<a href=#343 id=343 data-nosnippet>343</a>//! [log-reload]: https://docs.rs/log-reload/*/log_reload/
|
|
<a href=#344 id=344 data-nosnippet>344</a>//! [alterable_logger]: https://docs.rs/alterable_logger/*/alterable_logger
|
|
<a href=#345 id=345 data-nosnippet>345</a>//! [clang_log]: https://docs.rs/clang_log/latest/clang_log
|
|
<a href=#346 id=346 data-nosnippet>346</a>//! [ftail]: https://docs.rs/ftail/latest/ftail
|
|
<a href=#347 id=347 data-nosnippet>347</a>
|
|
<a href=#348 id=348 data-nosnippet>348</a></span><span class="attr">#![doc(
|
|
<a href=#349 id=349 data-nosnippet>349</a> html_logo_url = <span class="string">"https://prev.rust-lang.org/logos/rust-logo-128x128-blk-v2.png"</span>,
|
|
<a href=#350 id=350 data-nosnippet>350</a> html_favicon_url = <span class="string">"https://prev.rust-lang.org/favicon.ico"</span>,
|
|
<a href=#351 id=351 data-nosnippet>351</a> html_root_url = <span class="string">"https://docs.rs/log/0.4.29"
|
|
<a href=#352 id=352 data-nosnippet>352</a></span>)]
|
|
<a href=#353 id=353 data-nosnippet>353</a>#![warn(missing_docs)]
|
|
<a href=#354 id=354 data-nosnippet>354</a>#![deny(missing_debug_implementations, unconditional_recursion)]
|
|
<a href=#355 id=355 data-nosnippet>355</a>#![cfg_attr(all(not(feature = <span class="string">"std"</span>), not(test)), no_std)]
|
|
<a href=#356 id=356 data-nosnippet>356</a>
|
|
<a href=#357 id=357 data-nosnippet>357</a>#[cfg(any(
|
|
<a href=#358 id=358 data-nosnippet>358</a> all(feature = <span class="string">"max_level_off"</span>, feature = <span class="string">"max_level_error"</span>),
|
|
<a href=#359 id=359 data-nosnippet>359</a> all(feature = <span class="string">"max_level_off"</span>, feature = <span class="string">"max_level_warn"</span>),
|
|
<a href=#360 id=360 data-nosnippet>360</a> all(feature = <span class="string">"max_level_off"</span>, feature = <span class="string">"max_level_info"</span>),
|
|
<a href=#361 id=361 data-nosnippet>361</a> all(feature = <span class="string">"max_level_off"</span>, feature = <span class="string">"max_level_debug"</span>),
|
|
<a href=#362 id=362 data-nosnippet>362</a> all(feature = <span class="string">"max_level_off"</span>, feature = <span class="string">"max_level_trace"</span>),
|
|
<a href=#363 id=363 data-nosnippet>363</a> all(feature = <span class="string">"max_level_error"</span>, feature = <span class="string">"max_level_warn"</span>),
|
|
<a href=#364 id=364 data-nosnippet>364</a> all(feature = <span class="string">"max_level_error"</span>, feature = <span class="string">"max_level_info"</span>),
|
|
<a href=#365 id=365 data-nosnippet>365</a> all(feature = <span class="string">"max_level_error"</span>, feature = <span class="string">"max_level_debug"</span>),
|
|
<a href=#366 id=366 data-nosnippet>366</a> all(feature = <span class="string">"max_level_error"</span>, feature = <span class="string">"max_level_trace"</span>),
|
|
<a href=#367 id=367 data-nosnippet>367</a> all(feature = <span class="string">"max_level_warn"</span>, feature = <span class="string">"max_level_info"</span>),
|
|
<a href=#368 id=368 data-nosnippet>368</a> all(feature = <span class="string">"max_level_warn"</span>, feature = <span class="string">"max_level_debug"</span>),
|
|
<a href=#369 id=369 data-nosnippet>369</a> all(feature = <span class="string">"max_level_warn"</span>, feature = <span class="string">"max_level_trace"</span>),
|
|
<a href=#370 id=370 data-nosnippet>370</a> all(feature = <span class="string">"max_level_info"</span>, feature = <span class="string">"max_level_debug"</span>),
|
|
<a href=#371 id=371 data-nosnippet>371</a> all(feature = <span class="string">"max_level_info"</span>, feature = <span class="string">"max_level_trace"</span>),
|
|
<a href=#372 id=372 data-nosnippet>372</a> all(feature = <span class="string">"max_level_debug"</span>, feature = <span class="string">"max_level_trace"</span>),
|
|
<a href=#373 id=373 data-nosnippet>373</a>))]
|
|
<a href=#374 id=374 data-nosnippet>374</a></span><span class="macro">compile_error!</span>(<span class="string">"multiple max_level_* features set"</span>);
|
|
<a href=#375 id=375 data-nosnippet>375</a>
|
|
<a href=#376 id=376 data-nosnippet>376</a><span class="attr">#[rustfmt::skip]
|
|
<a href=#377 id=377 data-nosnippet>377</a>#[cfg(any(
|
|
<a href=#378 id=378 data-nosnippet>378</a> all(feature = <span class="string">"release_max_level_off"</span>, feature = <span class="string">"release_max_level_error"</span>),
|
|
<a href=#379 id=379 data-nosnippet>379</a> all(feature = <span class="string">"release_max_level_off"</span>, feature = <span class="string">"release_max_level_warn"</span>),
|
|
<a href=#380 id=380 data-nosnippet>380</a> all(feature = <span class="string">"release_max_level_off"</span>, feature = <span class="string">"release_max_level_info"</span>),
|
|
<a href=#381 id=381 data-nosnippet>381</a> all(feature = <span class="string">"release_max_level_off"</span>, feature = <span class="string">"release_max_level_debug"</span>),
|
|
<a href=#382 id=382 data-nosnippet>382</a> all(feature = <span class="string">"release_max_level_off"</span>, feature = <span class="string">"release_max_level_trace"</span>),
|
|
<a href=#383 id=383 data-nosnippet>383</a> all(feature = <span class="string">"release_max_level_error"</span>, feature = <span class="string">"release_max_level_warn"</span>),
|
|
<a href=#384 id=384 data-nosnippet>384</a> all(feature = <span class="string">"release_max_level_error"</span>, feature = <span class="string">"release_max_level_info"</span>),
|
|
<a href=#385 id=385 data-nosnippet>385</a> all(feature = <span class="string">"release_max_level_error"</span>, feature = <span class="string">"release_max_level_debug"</span>),
|
|
<a href=#386 id=386 data-nosnippet>386</a> all(feature = <span class="string">"release_max_level_error"</span>, feature = <span class="string">"release_max_level_trace"</span>),
|
|
<a href=#387 id=387 data-nosnippet>387</a> all(feature = <span class="string">"release_max_level_warn"</span>, feature = <span class="string">"release_max_level_info"</span>),
|
|
<a href=#388 id=388 data-nosnippet>388</a> all(feature = <span class="string">"release_max_level_warn"</span>, feature = <span class="string">"release_max_level_debug"</span>),
|
|
<a href=#389 id=389 data-nosnippet>389</a> all(feature = <span class="string">"release_max_level_warn"</span>, feature = <span class="string">"release_max_level_trace"</span>),
|
|
<a href=#390 id=390 data-nosnippet>390</a> all(feature = <span class="string">"release_max_level_info"</span>, feature = <span class="string">"release_max_level_debug"</span>),
|
|
<a href=#391 id=391 data-nosnippet>391</a> all(feature = <span class="string">"release_max_level_info"</span>, feature = <span class="string">"release_max_level_trace"</span>),
|
|
<a href=#392 id=392 data-nosnippet>392</a> all(feature = <span class="string">"release_max_level_debug"</span>, feature = <span class="string">"release_max_level_trace"</span>),
|
|
<a href=#393 id=393 data-nosnippet>393</a>))]
|
|
<a href=#394 id=394 data-nosnippet>394</a></span><span class="macro">compile_error!</span>(<span class="string">"multiple release_max_level_* features set"</span>);
|
|
<a href=#395 id=395 data-nosnippet>395</a>
|
|
<a href=#396 id=396 data-nosnippet>396</a><span class="attr">#[cfg(all(not(feature = <span class="string">"std"</span>), not(test)))]
|
|
<a href=#397 id=397 data-nosnippet>397</a></span><span class="kw">extern crate </span>core <span class="kw">as </span>std;
|
|
<a href=#398 id=398 data-nosnippet>398</a>
|
|
<a href=#399 id=399 data-nosnippet>399</a><span class="kw">use </span>std::cfg;
|
|
<a href=#400 id=400 data-nosnippet>400</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#401 id=401 data-nosnippet>401</a></span><span class="kw">use </span>std::error;
|
|
<a href=#402 id=402 data-nosnippet>402</a><span class="kw">use </span>std::str::FromStr;
|
|
<a href=#403 id=403 data-nosnippet>403</a><span class="kw">use </span>std::{cmp, fmt, mem};
|
|
<a href=#404 id=404 data-nosnippet>404</a>
|
|
<a href=#405 id=405 data-nosnippet>405</a><span class="attr">#[macro_use]
|
|
<a href=#406 id=406 data-nosnippet>406</a></span><span class="kw">mod </span>macros;
|
|
<a href=#407 id=407 data-nosnippet>407</a><span class="kw">mod </span>serde;
|
|
<a href=#408 id=408 data-nosnippet>408</a>
|
|
<a href=#409 id=409 data-nosnippet>409</a><span class="attr">#[cfg(feature = <span class="string">"kv"</span>)]
|
|
<a href=#410 id=410 data-nosnippet>410</a></span><span class="kw">pub mod </span>kv;
|
|
<a href=#411 id=411 data-nosnippet>411</a>
|
|
<a href=#412 id=412 data-nosnippet>412</a><span class="attr">#[cfg(target_has_atomic = <span class="string">"ptr"</span>)]
|
|
<a href=#413 id=413 data-nosnippet>413</a></span><span class="kw">use </span>std::sync::atomic::{AtomicUsize, Ordering};
|
|
<a href=#414 id=414 data-nosnippet>414</a>
|
|
<a href=#415 id=415 data-nosnippet>415</a><span class="attr">#[cfg(not(target_has_atomic = <span class="string">"ptr"</span>))]
|
|
<a href=#416 id=416 data-nosnippet>416</a></span><span class="kw">use </span>std::cell::Cell;
|
|
<a href=#417 id=417 data-nosnippet>417</a><span class="attr">#[cfg(not(target_has_atomic = <span class="string">"ptr"</span>))]
|
|
<a href=#418 id=418 data-nosnippet>418</a></span><span class="kw">use </span>std::sync::atomic::Ordering;
|
|
<a href=#419 id=419 data-nosnippet>419</a>
|
|
<a href=#420 id=420 data-nosnippet>420</a><span class="attr">#[cfg(not(target_has_atomic = <span class="string">"ptr"</span>))]
|
|
<a href=#421 id=421 data-nosnippet>421</a></span><span class="kw">struct </span>AtomicUsize {
|
|
<a href=#422 id=422 data-nosnippet>422</a> v: Cell<usize>,
|
|
<a href=#423 id=423 data-nosnippet>423</a>}
|
|
<a href=#424 id=424 data-nosnippet>424</a>
|
|
<a href=#425 id=425 data-nosnippet>425</a><span class="attr">#[cfg(not(target_has_atomic = <span class="string">"ptr"</span>))]
|
|
<a href=#426 id=426 data-nosnippet>426</a></span><span class="kw">impl </span>AtomicUsize {
|
|
<a href=#427 id=427 data-nosnippet>427</a> <span class="kw">const fn </span>new(v: usize) -> AtomicUsize {
|
|
<a href=#428 id=428 data-nosnippet>428</a> AtomicUsize { v: Cell::new(v) }
|
|
<a href=#429 id=429 data-nosnippet>429</a> }
|
|
<a href=#430 id=430 data-nosnippet>430</a>
|
|
<a href=#431 id=431 data-nosnippet>431</a> <span class="kw">fn </span>load(<span class="kw-2">&</span><span class="self">self</span>, _order: Ordering) -> usize {
|
|
<a href=#432 id=432 data-nosnippet>432</a> <span class="self">self</span>.v.get()
|
|
<a href=#433 id=433 data-nosnippet>433</a> }
|
|
<a href=#434 id=434 data-nosnippet>434</a>
|
|
<a href=#435 id=435 data-nosnippet>435</a> <span class="kw">fn </span>store(<span class="kw-2">&</span><span class="self">self</span>, val: usize, _order: Ordering) {
|
|
<a href=#436 id=436 data-nosnippet>436</a> <span class="self">self</span>.v.set(val)
|
|
<a href=#437 id=437 data-nosnippet>437</a> }
|
|
<a href=#438 id=438 data-nosnippet>438</a>}
|
|
<a href=#439 id=439 data-nosnippet>439</a>
|
|
<a href=#440 id=440 data-nosnippet>440</a><span class="comment">// Any platform without atomics is unlikely to have multiple cores, so
|
|
<a href=#441 id=441 data-nosnippet>441</a>// writing via Cell will not be a race condition.
|
|
<a href=#442 id=442 data-nosnippet>442</a></span><span class="attr">#[cfg(not(target_has_atomic = <span class="string">"ptr"</span>))]
|
|
<a href=#443 id=443 data-nosnippet>443</a></span><span class="kw">unsafe impl </span>Sync <span class="kw">for </span>AtomicUsize {}
|
|
<a href=#444 id=444 data-nosnippet>444</a>
|
|
<a href=#445 id=445 data-nosnippet>445</a><span class="comment">// The LOGGER static holds a pointer to the global logger. It is protected by
|
|
<a href=#446 id=446 data-nosnippet>446</a>// the STATE static which determines whether LOGGER has been initialized yet.
|
|
<a href=#447 id=447 data-nosnippet>447</a></span><span class="kw">static </span><span class="kw-2">mut </span>LOGGER: <span class="kw-2">&</span><span class="kw">dyn </span>Log = <span class="kw-2">&</span>NopLogger;
|
|
<a href=#448 id=448 data-nosnippet>448</a>
|
|
<a href=#449 id=449 data-nosnippet>449</a><span class="kw">static </span>STATE: AtomicUsize = AtomicUsize::new(<span class="number">0</span>);
|
|
<a href=#450 id=450 data-nosnippet>450</a>
|
|
<a href=#451 id=451 data-nosnippet>451</a><span class="comment">// There are three different states that we care about: the logger's
|
|
<a href=#452 id=452 data-nosnippet>452</a>// uninitialized, the logger's initializing (set_logger's been called but
|
|
<a href=#453 id=453 data-nosnippet>453</a>// LOGGER hasn't actually been set yet), or the logger's active.
|
|
<a href=#454 id=454 data-nosnippet>454</a></span><span class="kw">const </span>UNINITIALIZED: usize = <span class="number">0</span>;
|
|
<a href=#455 id=455 data-nosnippet>455</a><span class="kw">const </span>INITIALIZING: usize = <span class="number">1</span>;
|
|
<a href=#456 id=456 data-nosnippet>456</a><span class="kw">const </span>INITIALIZED: usize = <span class="number">2</span>;
|
|
<a href=#457 id=457 data-nosnippet>457</a>
|
|
<a href=#458 id=458 data-nosnippet>458</a><span class="kw">static </span>MAX_LOG_LEVEL_FILTER: AtomicUsize = AtomicUsize::new(<span class="number">0</span>);
|
|
<a href=#459 id=459 data-nosnippet>459</a>
|
|
<a href=#460 id=460 data-nosnippet>460</a><span class="kw">static </span>LOG_LEVEL_NAMES: [<span class="kw-2">&</span>str; <span class="number">6</span>] = [<span class="string">"OFF"</span>, <span class="string">"ERROR"</span>, <span class="string">"WARN"</span>, <span class="string">"INFO"</span>, <span class="string">"DEBUG"</span>, <span class="string">"TRACE"</span>];
|
|
<a href=#461 id=461 data-nosnippet>461</a>
|
|
<a href=#462 id=462 data-nosnippet>462</a><span class="kw">static </span>SET_LOGGER_ERROR: <span class="kw-2">&</span>str = <span class="string">"attempted to set a logger after the logging system \
|
|
<a href=#463 id=463 data-nosnippet>463</a> was already initialized"</span>;
|
|
<a href=#464 id=464 data-nosnippet>464</a><span class="kw">static </span>LEVEL_PARSE_ERROR: <span class="kw-2">&</span>str =
|
|
<a href=#465 id=465 data-nosnippet>465</a> <span class="string">"attempted to convert a string that doesn't match an existing log level"</span>;
|
|
<a href=#466 id=466 data-nosnippet>466</a>
|
|
<a href=#467 id=467 data-nosnippet>467</a><span class="doccomment">/// An enum representing the available verbosity levels of the logger.
|
|
<a href=#468 id=468 data-nosnippet>468</a>///
|
|
<a href=#469 id=469 data-nosnippet>469</a>/// Typical usage includes: checking if a certain `Level` is enabled with
|
|
<a href=#470 id=470 data-nosnippet>470</a>/// [`log_enabled!`](macro.log_enabled.html), specifying the `Level` of
|
|
<a href=#471 id=471 data-nosnippet>471</a>/// [`log!`](macro.log.html), and comparing a `Level` directly to a
|
|
<a href=#472 id=472 data-nosnippet>472</a>/// [`LevelFilter`](enum.LevelFilter.html).
|
|
<a href=#473 id=473 data-nosnippet>473</a></span><span class="attr">#[repr(usize)]
|
|
<a href=#474 id=474 data-nosnippet>474</a>#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
|
|
<a href=#475 id=475 data-nosnippet>475</a></span><span class="kw">pub enum </span>Level {
|
|
<a href=#476 id=476 data-nosnippet>476</a> <span class="doccomment">/// The "error" level.
|
|
<a href=#477 id=477 data-nosnippet>477</a> ///
|
|
<a href=#478 id=478 data-nosnippet>478</a> /// Designates very serious errors.
|
|
<a href=#479 id=479 data-nosnippet>479</a> </span><span class="comment">// This way these line up with the discriminants for LevelFilter below
|
|
<a href=#480 id=480 data-nosnippet>480</a> // This works because Rust treats field-less enums the same way as C does:
|
|
<a href=#481 id=481 data-nosnippet>481</a> // https://doc.rust-lang.org/reference/items/enumerations.html#custom-discriminant-values-for-field-less-enumerations
|
|
<a href=#482 id=482 data-nosnippet>482</a> </span>Error = <span class="number">1</span>,
|
|
<a href=#483 id=483 data-nosnippet>483</a> <span class="doccomment">/// The "warn" level.
|
|
<a href=#484 id=484 data-nosnippet>484</a> ///
|
|
<a href=#485 id=485 data-nosnippet>485</a> /// Designates hazardous situations.
|
|
<a href=#486 id=486 data-nosnippet>486</a> </span>Warn,
|
|
<a href=#487 id=487 data-nosnippet>487</a> <span class="doccomment">/// The "info" level.
|
|
<a href=#488 id=488 data-nosnippet>488</a> ///
|
|
<a href=#489 id=489 data-nosnippet>489</a> /// Designates useful information.
|
|
<a href=#490 id=490 data-nosnippet>490</a> </span>Info,
|
|
<a href=#491 id=491 data-nosnippet>491</a> <span class="doccomment">/// The "debug" level.
|
|
<a href=#492 id=492 data-nosnippet>492</a> ///
|
|
<a href=#493 id=493 data-nosnippet>493</a> /// Designates lower priority information.
|
|
<a href=#494 id=494 data-nosnippet>494</a> </span>Debug,
|
|
<a href=#495 id=495 data-nosnippet>495</a> <span class="doccomment">/// The "trace" level.
|
|
<a href=#496 id=496 data-nosnippet>496</a> ///
|
|
<a href=#497 id=497 data-nosnippet>497</a> /// Designates very low priority, often extremely verbose, information.
|
|
<a href=#498 id=498 data-nosnippet>498</a> </span>Trace,
|
|
<a href=#499 id=499 data-nosnippet>499</a>}
|
|
<a href=#500 id=500 data-nosnippet>500</a>
|
|
<a href=#501 id=501 data-nosnippet>501</a><span class="kw">impl </span>PartialEq<LevelFilter> <span class="kw">for </span>Level {
|
|
<a href=#502 id=502 data-nosnippet>502</a> <span class="attr">#[inline]
|
|
<a href=#503 id=503 data-nosnippet>503</a> </span><span class="kw">fn </span>eq(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span>LevelFilter) -> bool {
|
|
<a href=#504 id=504 data-nosnippet>504</a> <span class="kw-2">*</span><span class="self">self </span><span class="kw">as </span>usize == <span class="kw-2">*</span>other <span class="kw">as </span>usize
|
|
<a href=#505 id=505 data-nosnippet>505</a> }
|
|
<a href=#506 id=506 data-nosnippet>506</a>}
|
|
<a href=#507 id=507 data-nosnippet>507</a>
|
|
<a href=#508 id=508 data-nosnippet>508</a><span class="kw">impl </span>PartialOrd<LevelFilter> <span class="kw">for </span>Level {
|
|
<a href=#509 id=509 data-nosnippet>509</a> <span class="attr">#[inline]
|
|
<a href=#510 id=510 data-nosnippet>510</a> </span><span class="kw">fn </span>partial_cmp(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span>LevelFilter) -> <span class="prelude-ty">Option</span><cmp::Ordering> {
|
|
<a href=#511 id=511 data-nosnippet>511</a> <span class="prelude-val">Some</span>((<span class="kw-2">*</span><span class="self">self </span><span class="kw">as </span>usize).cmp(<span class="kw-2">&</span>(<span class="kw-2">*</span>other <span class="kw">as </span>usize)))
|
|
<a href=#512 id=512 data-nosnippet>512</a> }
|
|
<a href=#513 id=513 data-nosnippet>513</a>}
|
|
<a href=#514 id=514 data-nosnippet>514</a>
|
|
<a href=#515 id=515 data-nosnippet>515</a><span class="kw">impl </span>FromStr <span class="kw">for </span>Level {
|
|
<a href=#516 id=516 data-nosnippet>516</a> <span class="kw">type </span><span class="prelude-val">Err </span>= ParseLevelError;
|
|
<a href=#517 id=517 data-nosnippet>517</a> <span class="kw">fn </span>from_str(level: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><Level, <span class="self">Self</span>::Err> {
|
|
<a href=#518 id=518 data-nosnippet>518</a> <span class="comment">// iterate from 1, excluding "OFF"
|
|
<a href=#519 id=519 data-nosnippet>519</a> </span><span class="kw">for </span>idx <span class="kw">in </span><span class="number">1</span>..LOG_LEVEL_NAMES.len() {
|
|
<a href=#520 id=520 data-nosnippet>520</a> <span class="kw">if </span>LOG_LEVEL_NAMES[idx].eq_ignore_ascii_case(level) {
|
|
<a href=#521 id=521 data-nosnippet>521</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(Level::from_usize(idx).unwrap());
|
|
<a href=#522 id=522 data-nosnippet>522</a> }
|
|
<a href=#523 id=523 data-nosnippet>523</a> }
|
|
<a href=#524 id=524 data-nosnippet>524</a> <span class="prelude-val">Err</span>(ParseLevelError(()))
|
|
<a href=#525 id=525 data-nosnippet>525</a> }
|
|
<a href=#526 id=526 data-nosnippet>526</a>}
|
|
<a href=#527 id=527 data-nosnippet>527</a>
|
|
<a href=#528 id=528 data-nosnippet>528</a><span class="kw">impl </span>fmt::Display <span class="kw">for </span>Level {
|
|
<a href=#529 id=529 data-nosnippet>529</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result {
|
|
<a href=#530 id=530 data-nosnippet>530</a> fmt.pad(<span class="self">self</span>.as_str())
|
|
<a href=#531 id=531 data-nosnippet>531</a> }
|
|
<a href=#532 id=532 data-nosnippet>532</a>}
|
|
<a href=#533 id=533 data-nosnippet>533</a>
|
|
<a href=#534 id=534 data-nosnippet>534</a><span class="kw">impl </span>Level {
|
|
<a href=#535 id=535 data-nosnippet>535</a> <span class="kw">fn </span>from_usize(u: usize) -> <span class="prelude-ty">Option</span><Level> {
|
|
<a href=#536 id=536 data-nosnippet>536</a> <span class="kw">match </span>u {
|
|
<a href=#537 id=537 data-nosnippet>537</a> <span class="number">1 </span>=> <span class="prelude-val">Some</span>(Level::Error),
|
|
<a href=#538 id=538 data-nosnippet>538</a> <span class="number">2 </span>=> <span class="prelude-val">Some</span>(Level::Warn),
|
|
<a href=#539 id=539 data-nosnippet>539</a> <span class="number">3 </span>=> <span class="prelude-val">Some</span>(Level::Info),
|
|
<a href=#540 id=540 data-nosnippet>540</a> <span class="number">4 </span>=> <span class="prelude-val">Some</span>(Level::Debug),
|
|
<a href=#541 id=541 data-nosnippet>541</a> <span class="number">5 </span>=> <span class="prelude-val">Some</span>(Level::Trace),
|
|
<a href=#542 id=542 data-nosnippet>542</a> <span class="kw">_ </span>=> <span class="prelude-val">None</span>,
|
|
<a href=#543 id=543 data-nosnippet>543</a> }
|
|
<a href=#544 id=544 data-nosnippet>544</a> }
|
|
<a href=#545 id=545 data-nosnippet>545</a>
|
|
<a href=#546 id=546 data-nosnippet>546</a> <span class="doccomment">/// Returns the most verbose logging level.
|
|
<a href=#547 id=547 data-nosnippet>547</a> </span><span class="attr">#[inline]
|
|
<a href=#548 id=548 data-nosnippet>548</a> </span><span class="kw">pub fn </span>max() -> Level {
|
|
<a href=#549 id=549 data-nosnippet>549</a> Level::Trace
|
|
<a href=#550 id=550 data-nosnippet>550</a> }
|
|
<a href=#551 id=551 data-nosnippet>551</a>
|
|
<a href=#552 id=552 data-nosnippet>552</a> <span class="doccomment">/// Converts the `Level` to the equivalent `LevelFilter`.
|
|
<a href=#553 id=553 data-nosnippet>553</a> </span><span class="attr">#[inline]
|
|
<a href=#554 id=554 data-nosnippet>554</a> </span><span class="kw">pub fn </span>to_level_filter(<span class="kw-2">&</span><span class="self">self</span>) -> LevelFilter {
|
|
<a href=#555 id=555 data-nosnippet>555</a> LevelFilter::from_usize(<span class="kw-2">*</span><span class="self">self </span><span class="kw">as </span>usize).unwrap()
|
|
<a href=#556 id=556 data-nosnippet>556</a> }
|
|
<a href=#557 id=557 data-nosnippet>557</a>
|
|
<a href=#558 id=558 data-nosnippet>558</a> <span class="doccomment">/// Returns the string representation of the `Level`.
|
|
<a href=#559 id=559 data-nosnippet>559</a> ///
|
|
<a href=#560 id=560 data-nosnippet>560</a> /// This returns the same string as the `fmt::Display` implementation.
|
|
<a href=#561 id=561 data-nosnippet>561</a> </span><span class="kw">pub fn </span>as_str(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'static </span>str {
|
|
<a href=#562 id=562 data-nosnippet>562</a> LOG_LEVEL_NAMES[<span class="kw-2">*</span><span class="self">self </span><span class="kw">as </span>usize]
|
|
<a href=#563 id=563 data-nosnippet>563</a> }
|
|
<a href=#564 id=564 data-nosnippet>564</a>
|
|
<a href=#565 id=565 data-nosnippet>565</a> <span class="doccomment">/// Iterate through all supported logging levels.
|
|
<a href=#566 id=566 data-nosnippet>566</a> ///
|
|
<a href=#567 id=567 data-nosnippet>567</a> /// The order of iteration is from more severe to less severe log messages.
|
|
<a href=#568 id=568 data-nosnippet>568</a> ///
|
|
<a href=#569 id=569 data-nosnippet>569</a> /// # Examples
|
|
<a href=#570 id=570 data-nosnippet>570</a> ///
|
|
<a href=#571 id=571 data-nosnippet>571</a> /// ```
|
|
<a href=#572 id=572 data-nosnippet>572</a> /// use log::Level;
|
|
<a href=#573 id=573 data-nosnippet>573</a> ///
|
|
<a href=#574 id=574 data-nosnippet>574</a> /// let mut levels = Level::iter();
|
|
<a href=#575 id=575 data-nosnippet>575</a> ///
|
|
<a href=#576 id=576 data-nosnippet>576</a> /// assert_eq!(Some(Level::Error), levels.next());
|
|
<a href=#577 id=577 data-nosnippet>577</a> /// assert_eq!(Some(Level::Trace), levels.last());
|
|
<a href=#578 id=578 data-nosnippet>578</a> /// ```
|
|
<a href=#579 id=579 data-nosnippet>579</a> </span><span class="kw">pub fn </span>iter() -> <span class="kw">impl </span>Iterator<Item = <span class="self">Self</span>> {
|
|
<a href=#580 id=580 data-nosnippet>580</a> (<span class="number">1</span>..<span class="number">6</span>).map(|i| <span class="self">Self</span>::from_usize(i).unwrap())
|
|
<a href=#581 id=581 data-nosnippet>581</a> }
|
|
<a href=#582 id=582 data-nosnippet>582</a>
|
|
<a href=#583 id=583 data-nosnippet>583</a> <span class="doccomment">/// Get the next-highest `Level` from this one.
|
|
<a href=#584 id=584 data-nosnippet>584</a> ///
|
|
<a href=#585 id=585 data-nosnippet>585</a> /// If the current `Level` is at the highest level, the returned `Level` will be the same as the
|
|
<a href=#586 id=586 data-nosnippet>586</a> /// current one.
|
|
<a href=#587 id=587 data-nosnippet>587</a> ///
|
|
<a href=#588 id=588 data-nosnippet>588</a> /// # Examples
|
|
<a href=#589 id=589 data-nosnippet>589</a> ///
|
|
<a href=#590 id=590 data-nosnippet>590</a> /// ```
|
|
<a href=#591 id=591 data-nosnippet>591</a> /// use log::Level;
|
|
<a href=#592 id=592 data-nosnippet>592</a> ///
|
|
<a href=#593 id=593 data-nosnippet>593</a> /// let level = Level::Info;
|
|
<a href=#594 id=594 data-nosnippet>594</a> ///
|
|
<a href=#595 id=595 data-nosnippet>595</a> /// assert_eq!(Level::Debug, level.increment_severity());
|
|
<a href=#596 id=596 data-nosnippet>596</a> /// assert_eq!(Level::Trace, level.increment_severity().increment_severity());
|
|
<a href=#597 id=597 data-nosnippet>597</a> /// assert_eq!(Level::Trace, level.increment_severity().increment_severity().increment_severity()); // max level
|
|
<a href=#598 id=598 data-nosnippet>598</a> /// ```
|
|
<a href=#599 id=599 data-nosnippet>599</a> </span><span class="kw">pub fn </span>increment_severity(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{
|
|
<a href=#600 id=600 data-nosnippet>600</a> <span class="kw">let </span>current = <span class="kw-2">*</span><span class="self">self </span><span class="kw">as </span>usize;
|
|
<a href=#601 id=601 data-nosnippet>601</a> <span class="self">Self</span>::from_usize(current + <span class="number">1</span>).unwrap_or(<span class="kw-2">*</span><span class="self">self</span>)
|
|
<a href=#602 id=602 data-nosnippet>602</a> }
|
|
<a href=#603 id=603 data-nosnippet>603</a>
|
|
<a href=#604 id=604 data-nosnippet>604</a> <span class="doccomment">/// Get the next-lowest `Level` from this one.
|
|
<a href=#605 id=605 data-nosnippet>605</a> ///
|
|
<a href=#606 id=606 data-nosnippet>606</a> /// If the current `Level` is at the lowest level, the returned `Level` will be the same as the
|
|
<a href=#607 id=607 data-nosnippet>607</a> /// current one.
|
|
<a href=#608 id=608 data-nosnippet>608</a> ///
|
|
<a href=#609 id=609 data-nosnippet>609</a> /// # Examples
|
|
<a href=#610 id=610 data-nosnippet>610</a> ///
|
|
<a href=#611 id=611 data-nosnippet>611</a> /// ```
|
|
<a href=#612 id=612 data-nosnippet>612</a> /// use log::Level;
|
|
<a href=#613 id=613 data-nosnippet>613</a> ///
|
|
<a href=#614 id=614 data-nosnippet>614</a> /// let level = Level::Info;
|
|
<a href=#615 id=615 data-nosnippet>615</a> ///
|
|
<a href=#616 id=616 data-nosnippet>616</a> /// assert_eq!(Level::Warn, level.decrement_severity());
|
|
<a href=#617 id=617 data-nosnippet>617</a> /// assert_eq!(Level::Error, level.decrement_severity().decrement_severity());
|
|
<a href=#618 id=618 data-nosnippet>618</a> /// assert_eq!(Level::Error, level.decrement_severity().decrement_severity().decrement_severity()); // min level
|
|
<a href=#619 id=619 data-nosnippet>619</a> /// ```
|
|
<a href=#620 id=620 data-nosnippet>620</a> </span><span class="kw">pub fn </span>decrement_severity(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{
|
|
<a href=#621 id=621 data-nosnippet>621</a> <span class="kw">let </span>current = <span class="kw-2">*</span><span class="self">self </span><span class="kw">as </span>usize;
|
|
<a href=#622 id=622 data-nosnippet>622</a> <span class="self">Self</span>::from_usize(current.saturating_sub(<span class="number">1</span>)).unwrap_or(<span class="kw-2">*</span><span class="self">self</span>)
|
|
<a href=#623 id=623 data-nosnippet>623</a> }
|
|
<a href=#624 id=624 data-nosnippet>624</a>}
|
|
<a href=#625 id=625 data-nosnippet>625</a>
|
|
<a href=#626 id=626 data-nosnippet>626</a><span class="doccomment">/// An enum representing the available verbosity level filters of the logger.
|
|
<a href=#627 id=627 data-nosnippet>627</a>///
|
|
<a href=#628 id=628 data-nosnippet>628</a>/// A `LevelFilter` may be compared directly to a [`Level`]. Use this type
|
|
<a href=#629 id=629 data-nosnippet>629</a>/// to get and set the maximum log level with [`max_level()`] and [`set_max_level`].
|
|
<a href=#630 id=630 data-nosnippet>630</a>///
|
|
<a href=#631 id=631 data-nosnippet>631</a>/// [`Level`]: enum.Level.html
|
|
<a href=#632 id=632 data-nosnippet>632</a>/// [`max_level()`]: fn.max_level.html
|
|
<a href=#633 id=633 data-nosnippet>633</a>/// [`set_max_level`]: fn.set_max_level.html
|
|
<a href=#634 id=634 data-nosnippet>634</a></span><span class="attr">#[repr(usize)]
|
|
<a href=#635 id=635 data-nosnippet>635</a>#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
|
|
<a href=#636 id=636 data-nosnippet>636</a></span><span class="kw">pub enum </span>LevelFilter {
|
|
<a href=#637 id=637 data-nosnippet>637</a> <span class="doccomment">/// A level lower than all log levels.
|
|
<a href=#638 id=638 data-nosnippet>638</a> </span>Off,
|
|
<a href=#639 id=639 data-nosnippet>639</a> <span class="doccomment">/// Corresponds to the `Error` log level.
|
|
<a href=#640 id=640 data-nosnippet>640</a> </span>Error,
|
|
<a href=#641 id=641 data-nosnippet>641</a> <span class="doccomment">/// Corresponds to the `Warn` log level.
|
|
<a href=#642 id=642 data-nosnippet>642</a> </span>Warn,
|
|
<a href=#643 id=643 data-nosnippet>643</a> <span class="doccomment">/// Corresponds to the `Info` log level.
|
|
<a href=#644 id=644 data-nosnippet>644</a> </span>Info,
|
|
<a href=#645 id=645 data-nosnippet>645</a> <span class="doccomment">/// Corresponds to the `Debug` log level.
|
|
<a href=#646 id=646 data-nosnippet>646</a> </span>Debug,
|
|
<a href=#647 id=647 data-nosnippet>647</a> <span class="doccomment">/// Corresponds to the `Trace` log level.
|
|
<a href=#648 id=648 data-nosnippet>648</a> </span>Trace,
|
|
<a href=#649 id=649 data-nosnippet>649</a>}
|
|
<a href=#650 id=650 data-nosnippet>650</a>
|
|
<a href=#651 id=651 data-nosnippet>651</a><span class="kw">impl </span>PartialEq<Level> <span class="kw">for </span>LevelFilter {
|
|
<a href=#652 id=652 data-nosnippet>652</a> <span class="attr">#[inline]
|
|
<a href=#653 id=653 data-nosnippet>653</a> </span><span class="kw">fn </span>eq(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span>Level) -> bool {
|
|
<a href=#654 id=654 data-nosnippet>654</a> other.eq(<span class="self">self</span>)
|
|
<a href=#655 id=655 data-nosnippet>655</a> }
|
|
<a href=#656 id=656 data-nosnippet>656</a>}
|
|
<a href=#657 id=657 data-nosnippet>657</a>
|
|
<a href=#658 id=658 data-nosnippet>658</a><span class="kw">impl </span>PartialOrd<Level> <span class="kw">for </span>LevelFilter {
|
|
<a href=#659 id=659 data-nosnippet>659</a> <span class="attr">#[inline]
|
|
<a href=#660 id=660 data-nosnippet>660</a> </span><span class="kw">fn </span>partial_cmp(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span>Level) -> <span class="prelude-ty">Option</span><cmp::Ordering> {
|
|
<a href=#661 id=661 data-nosnippet>661</a> <span class="prelude-val">Some</span>((<span class="kw-2">*</span><span class="self">self </span><span class="kw">as </span>usize).cmp(<span class="kw-2">&</span>(<span class="kw-2">*</span>other <span class="kw">as </span>usize)))
|
|
<a href=#662 id=662 data-nosnippet>662</a> }
|
|
<a href=#663 id=663 data-nosnippet>663</a>}
|
|
<a href=#664 id=664 data-nosnippet>664</a>
|
|
<a href=#665 id=665 data-nosnippet>665</a><span class="kw">impl </span>FromStr <span class="kw">for </span>LevelFilter {
|
|
<a href=#666 id=666 data-nosnippet>666</a> <span class="kw">type </span><span class="prelude-val">Err </span>= ParseLevelError;
|
|
<a href=#667 id=667 data-nosnippet>667</a> <span class="kw">fn </span>from_str(level: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><LevelFilter, <span class="self">Self</span>::Err> {
|
|
<a href=#668 id=668 data-nosnippet>668</a> <span class="comment">// iterate from 0, including "OFF"
|
|
<a href=#669 id=669 data-nosnippet>669</a> </span><span class="kw">for </span>idx <span class="kw">in </span><span class="number">0</span>..LOG_LEVEL_NAMES.len() {
|
|
<a href=#670 id=670 data-nosnippet>670</a> <span class="kw">if </span>LOG_LEVEL_NAMES[idx].eq_ignore_ascii_case(level) {
|
|
<a href=#671 id=671 data-nosnippet>671</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(LevelFilter::from_usize(idx).unwrap());
|
|
<a href=#672 id=672 data-nosnippet>672</a> }
|
|
<a href=#673 id=673 data-nosnippet>673</a> }
|
|
<a href=#674 id=674 data-nosnippet>674</a> <span class="prelude-val">Err</span>(ParseLevelError(()))
|
|
<a href=#675 id=675 data-nosnippet>675</a> }
|
|
<a href=#676 id=676 data-nosnippet>676</a>}
|
|
<a href=#677 id=677 data-nosnippet>677</a>
|
|
<a href=#678 id=678 data-nosnippet>678</a><span class="kw">impl </span>fmt::Display <span class="kw">for </span>LevelFilter {
|
|
<a href=#679 id=679 data-nosnippet>679</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result {
|
|
<a href=#680 id=680 data-nosnippet>680</a> fmt.pad(<span class="self">self</span>.as_str())
|
|
<a href=#681 id=681 data-nosnippet>681</a> }
|
|
<a href=#682 id=682 data-nosnippet>682</a>}
|
|
<a href=#683 id=683 data-nosnippet>683</a>
|
|
<a href=#684 id=684 data-nosnippet>684</a><span class="kw">impl </span>LevelFilter {
|
|
<a href=#685 id=685 data-nosnippet>685</a> <span class="kw">fn </span>from_usize(u: usize) -> <span class="prelude-ty">Option</span><LevelFilter> {
|
|
<a href=#686 id=686 data-nosnippet>686</a> <span class="kw">match </span>u {
|
|
<a href=#687 id=687 data-nosnippet>687</a> <span class="number">0 </span>=> <span class="prelude-val">Some</span>(LevelFilter::Off),
|
|
<a href=#688 id=688 data-nosnippet>688</a> <span class="number">1 </span>=> <span class="prelude-val">Some</span>(LevelFilter::Error),
|
|
<a href=#689 id=689 data-nosnippet>689</a> <span class="number">2 </span>=> <span class="prelude-val">Some</span>(LevelFilter::Warn),
|
|
<a href=#690 id=690 data-nosnippet>690</a> <span class="number">3 </span>=> <span class="prelude-val">Some</span>(LevelFilter::Info),
|
|
<a href=#691 id=691 data-nosnippet>691</a> <span class="number">4 </span>=> <span class="prelude-val">Some</span>(LevelFilter::Debug),
|
|
<a href=#692 id=692 data-nosnippet>692</a> <span class="number">5 </span>=> <span class="prelude-val">Some</span>(LevelFilter::Trace),
|
|
<a href=#693 id=693 data-nosnippet>693</a> <span class="kw">_ </span>=> <span class="prelude-val">None</span>,
|
|
<a href=#694 id=694 data-nosnippet>694</a> }
|
|
<a href=#695 id=695 data-nosnippet>695</a> }
|
|
<a href=#696 id=696 data-nosnippet>696</a>
|
|
<a href=#697 id=697 data-nosnippet>697</a> <span class="doccomment">/// Returns the most verbose logging level filter.
|
|
<a href=#698 id=698 data-nosnippet>698</a> </span><span class="attr">#[inline]
|
|
<a href=#699 id=699 data-nosnippet>699</a> </span><span class="kw">pub fn </span>max() -> LevelFilter {
|
|
<a href=#700 id=700 data-nosnippet>700</a> LevelFilter::Trace
|
|
<a href=#701 id=701 data-nosnippet>701</a> }
|
|
<a href=#702 id=702 data-nosnippet>702</a>
|
|
<a href=#703 id=703 data-nosnippet>703</a> <span class="doccomment">/// Converts `self` to the equivalent `Level`.
|
|
<a href=#704 id=704 data-nosnippet>704</a> ///
|
|
<a href=#705 id=705 data-nosnippet>705</a> /// Returns `None` if `self` is `LevelFilter::Off`.
|
|
<a href=#706 id=706 data-nosnippet>706</a> </span><span class="attr">#[inline]
|
|
<a href=#707 id=707 data-nosnippet>707</a> </span><span class="kw">pub fn </span>to_level(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Level> {
|
|
<a href=#708 id=708 data-nosnippet>708</a> Level::from_usize(<span class="kw-2">*</span><span class="self">self </span><span class="kw">as </span>usize)
|
|
<a href=#709 id=709 data-nosnippet>709</a> }
|
|
<a href=#710 id=710 data-nosnippet>710</a>
|
|
<a href=#711 id=711 data-nosnippet>711</a> <span class="doccomment">/// Returns the string representation of the `LevelFilter`.
|
|
<a href=#712 id=712 data-nosnippet>712</a> ///
|
|
<a href=#713 id=713 data-nosnippet>713</a> /// This returns the same string as the `fmt::Display` implementation.
|
|
<a href=#714 id=714 data-nosnippet>714</a> </span><span class="kw">pub fn </span>as_str(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'static </span>str {
|
|
<a href=#715 id=715 data-nosnippet>715</a> LOG_LEVEL_NAMES[<span class="kw-2">*</span><span class="self">self </span><span class="kw">as </span>usize]
|
|
<a href=#716 id=716 data-nosnippet>716</a> }
|
|
<a href=#717 id=717 data-nosnippet>717</a>
|
|
<a href=#718 id=718 data-nosnippet>718</a> <span class="doccomment">/// Iterate through all supported filtering levels.
|
|
<a href=#719 id=719 data-nosnippet>719</a> ///
|
|
<a href=#720 id=720 data-nosnippet>720</a> /// The order of iteration is from less to more verbose filtering.
|
|
<a href=#721 id=721 data-nosnippet>721</a> ///
|
|
<a href=#722 id=722 data-nosnippet>722</a> /// # Examples
|
|
<a href=#723 id=723 data-nosnippet>723</a> ///
|
|
<a href=#724 id=724 data-nosnippet>724</a> /// ```
|
|
<a href=#725 id=725 data-nosnippet>725</a> /// use log::LevelFilter;
|
|
<a href=#726 id=726 data-nosnippet>726</a> ///
|
|
<a href=#727 id=727 data-nosnippet>727</a> /// let mut levels = LevelFilter::iter();
|
|
<a href=#728 id=728 data-nosnippet>728</a> ///
|
|
<a href=#729 id=729 data-nosnippet>729</a> /// assert_eq!(Some(LevelFilter::Off), levels.next());
|
|
<a href=#730 id=730 data-nosnippet>730</a> /// assert_eq!(Some(LevelFilter::Trace), levels.last());
|
|
<a href=#731 id=731 data-nosnippet>731</a> /// ```
|
|
<a href=#732 id=732 data-nosnippet>732</a> </span><span class="kw">pub fn </span>iter() -> <span class="kw">impl </span>Iterator<Item = <span class="self">Self</span>> {
|
|
<a href=#733 id=733 data-nosnippet>733</a> (<span class="number">0</span>..<span class="number">6</span>).map(|i| <span class="self">Self</span>::from_usize(i).unwrap())
|
|
<a href=#734 id=734 data-nosnippet>734</a> }
|
|
<a href=#735 id=735 data-nosnippet>735</a>
|
|
<a href=#736 id=736 data-nosnippet>736</a> <span class="doccomment">/// Get the next-highest `LevelFilter` from this one.
|
|
<a href=#737 id=737 data-nosnippet>737</a> ///
|
|
<a href=#738 id=738 data-nosnippet>738</a> /// If the current `LevelFilter` is at the highest level, the returned `LevelFilter` will be the
|
|
<a href=#739 id=739 data-nosnippet>739</a> /// same as the current one.
|
|
<a href=#740 id=740 data-nosnippet>740</a> ///
|
|
<a href=#741 id=741 data-nosnippet>741</a> /// # Examples
|
|
<a href=#742 id=742 data-nosnippet>742</a> ///
|
|
<a href=#743 id=743 data-nosnippet>743</a> /// ```
|
|
<a href=#744 id=744 data-nosnippet>744</a> /// use log::LevelFilter;
|
|
<a href=#745 id=745 data-nosnippet>745</a> ///
|
|
<a href=#746 id=746 data-nosnippet>746</a> /// let level_filter = LevelFilter::Info;
|
|
<a href=#747 id=747 data-nosnippet>747</a> ///
|
|
<a href=#748 id=748 data-nosnippet>748</a> /// assert_eq!(LevelFilter::Debug, level_filter.increment_severity());
|
|
<a href=#749 id=749 data-nosnippet>749</a> /// assert_eq!(LevelFilter::Trace, level_filter.increment_severity().increment_severity());
|
|
<a href=#750 id=750 data-nosnippet>750</a> /// assert_eq!(LevelFilter::Trace, level_filter.increment_severity().increment_severity().increment_severity()); // max level
|
|
<a href=#751 id=751 data-nosnippet>751</a> /// ```
|
|
<a href=#752 id=752 data-nosnippet>752</a> </span><span class="kw">pub fn </span>increment_severity(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{
|
|
<a href=#753 id=753 data-nosnippet>753</a> <span class="kw">let </span>current = <span class="kw-2">*</span><span class="self">self </span><span class="kw">as </span>usize;
|
|
<a href=#754 id=754 data-nosnippet>754</a> <span class="self">Self</span>::from_usize(current + <span class="number">1</span>).unwrap_or(<span class="kw-2">*</span><span class="self">self</span>)
|
|
<a href=#755 id=755 data-nosnippet>755</a> }
|
|
<a href=#756 id=756 data-nosnippet>756</a>
|
|
<a href=#757 id=757 data-nosnippet>757</a> <span class="doccomment">/// Get the next-lowest `LevelFilter` from this one.
|
|
<a href=#758 id=758 data-nosnippet>758</a> ///
|
|
<a href=#759 id=759 data-nosnippet>759</a> /// If the current `LevelFilter` is at the lowest level, the returned `LevelFilter` will be the
|
|
<a href=#760 id=760 data-nosnippet>760</a> /// same as the current one.
|
|
<a href=#761 id=761 data-nosnippet>761</a> ///
|
|
<a href=#762 id=762 data-nosnippet>762</a> /// # Examples
|
|
<a href=#763 id=763 data-nosnippet>763</a> ///
|
|
<a href=#764 id=764 data-nosnippet>764</a> /// ```
|
|
<a href=#765 id=765 data-nosnippet>765</a> /// use log::LevelFilter;
|
|
<a href=#766 id=766 data-nosnippet>766</a> ///
|
|
<a href=#767 id=767 data-nosnippet>767</a> /// let level_filter = LevelFilter::Info;
|
|
<a href=#768 id=768 data-nosnippet>768</a> ///
|
|
<a href=#769 id=769 data-nosnippet>769</a> /// assert_eq!(LevelFilter::Warn, level_filter.decrement_severity());
|
|
<a href=#770 id=770 data-nosnippet>770</a> /// assert_eq!(LevelFilter::Error, level_filter.decrement_severity().decrement_severity());
|
|
<a href=#771 id=771 data-nosnippet>771</a> /// assert_eq!(LevelFilter::Off, level_filter.decrement_severity().decrement_severity().decrement_severity());
|
|
<a href=#772 id=772 data-nosnippet>772</a> /// assert_eq!(LevelFilter::Off, level_filter.decrement_severity().decrement_severity().decrement_severity().decrement_severity()); // min level
|
|
<a href=#773 id=773 data-nosnippet>773</a> /// ```
|
|
<a href=#774 id=774 data-nosnippet>774</a> </span><span class="kw">pub fn </span>decrement_severity(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{
|
|
<a href=#775 id=775 data-nosnippet>775</a> <span class="kw">let </span>current = <span class="kw-2">*</span><span class="self">self </span><span class="kw">as </span>usize;
|
|
<a href=#776 id=776 data-nosnippet>776</a> <span class="self">Self</span>::from_usize(current.saturating_sub(<span class="number">1</span>)).unwrap_or(<span class="kw-2">*</span><span class="self">self</span>)
|
|
<a href=#777 id=777 data-nosnippet>777</a> }
|
|
<a href=#778 id=778 data-nosnippet>778</a>}
|
|
<a href=#779 id=779 data-nosnippet>779</a>
|
|
<a href=#780 id=780 data-nosnippet>780</a><span class="attr">#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
|
|
<a href=#781 id=781 data-nosnippet>781</a></span><span class="kw">enum </span>MaybeStaticStr<<span class="lifetime">'a</span>> {
|
|
<a href=#782 id=782 data-nosnippet>782</a> Static(<span class="kw-2">&</span><span class="lifetime">'static </span>str),
|
|
<a href=#783 id=783 data-nosnippet>783</a> Borrowed(<span class="kw-2">&</span><span class="lifetime">'a </span>str),
|
|
<a href=#784 id=784 data-nosnippet>784</a>}
|
|
<a href=#785 id=785 data-nosnippet>785</a>
|
|
<a href=#786 id=786 data-nosnippet>786</a><span class="kw">impl</span><<span class="lifetime">'a</span>> MaybeStaticStr<<span class="lifetime">'a</span>> {
|
|
<a href=#787 id=787 data-nosnippet>787</a> <span class="attr">#[inline]
|
|
<a href=#788 id=788 data-nosnippet>788</a> </span><span class="kw">fn </span>get(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'a </span>str {
|
|
<a href=#789 id=789 data-nosnippet>789</a> <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
|
|
<a href=#790 id=790 data-nosnippet>790</a> MaybeStaticStr::Static(s) => s,
|
|
<a href=#791 id=791 data-nosnippet>791</a> MaybeStaticStr::Borrowed(s) => s,
|
|
<a href=#792 id=792 data-nosnippet>792</a> }
|
|
<a href=#793 id=793 data-nosnippet>793</a> }
|
|
<a href=#794 id=794 data-nosnippet>794</a>}
|
|
<a href=#795 id=795 data-nosnippet>795</a>
|
|
<a href=#796 id=796 data-nosnippet>796</a><span class="doccomment">/// The "payload" of a log message.
|
|
<a href=#797 id=797 data-nosnippet>797</a>///
|
|
<a href=#798 id=798 data-nosnippet>798</a>/// # Use
|
|
<a href=#799 id=799 data-nosnippet>799</a>///
|
|
<a href=#800 id=800 data-nosnippet>800</a>/// `Record` structures are passed as parameters to the [`log`][method.log]
|
|
<a href=#801 id=801 data-nosnippet>801</a>/// method of the [`Log`] trait. Logger implementors manipulate these
|
|
<a href=#802 id=802 data-nosnippet>802</a>/// structures in order to display log messages. `Record`s are automatically
|
|
<a href=#803 id=803 data-nosnippet>803</a>/// created by the [`log!`] macro and so are not seen by log users.
|
|
<a href=#804 id=804 data-nosnippet>804</a>///
|
|
<a href=#805 id=805 data-nosnippet>805</a>/// Note that the [`level()`] and [`target()`] accessors are equivalent to
|
|
<a href=#806 id=806 data-nosnippet>806</a>/// `self.metadata().level()` and `self.metadata().target()` respectively.
|
|
<a href=#807 id=807 data-nosnippet>807</a>/// These methods are provided as a convenience for users of this structure.
|
|
<a href=#808 id=808 data-nosnippet>808</a>///
|
|
<a href=#809 id=809 data-nosnippet>809</a>/// # Example
|
|
<a href=#810 id=810 data-nosnippet>810</a>///
|
|
<a href=#811 id=811 data-nosnippet>811</a>/// The following example shows a simple logger that displays the level,
|
|
<a href=#812 id=812 data-nosnippet>812</a>/// module path, and message of any `Record` that is passed to it.
|
|
<a href=#813 id=813 data-nosnippet>813</a>///
|
|
<a href=#814 id=814 data-nosnippet>814</a>/// ```
|
|
<a href=#815 id=815 data-nosnippet>815</a>/// struct SimpleLogger;
|
|
<a href=#816 id=816 data-nosnippet>816</a>///
|
|
<a href=#817 id=817 data-nosnippet>817</a>/// impl log::Log for SimpleLogger {
|
|
<a href=#818 id=818 data-nosnippet>818</a>/// fn enabled(&self, _metadata: &log::Metadata) -> bool {
|
|
<a href=#819 id=819 data-nosnippet>819</a>/// true
|
|
<a href=#820 id=820 data-nosnippet>820</a>/// }
|
|
<a href=#821 id=821 data-nosnippet>821</a>///
|
|
<a href=#822 id=822 data-nosnippet>822</a>/// fn log(&self, record: &log::Record) {
|
|
<a href=#823 id=823 data-nosnippet>823</a>/// if !self.enabled(record.metadata()) {
|
|
<a href=#824 id=824 data-nosnippet>824</a>/// return;
|
|
<a href=#825 id=825 data-nosnippet>825</a>/// }
|
|
<a href=#826 id=826 data-nosnippet>826</a>///
|
|
<a href=#827 id=827 data-nosnippet>827</a>/// println!("{}:{} -- {}",
|
|
<a href=#828 id=828 data-nosnippet>828</a>/// record.level(),
|
|
<a href=#829 id=829 data-nosnippet>829</a>/// record.target(),
|
|
<a href=#830 id=830 data-nosnippet>830</a>/// record.args());
|
|
<a href=#831 id=831 data-nosnippet>831</a>/// }
|
|
<a href=#832 id=832 data-nosnippet>832</a>/// fn flush(&self) {}
|
|
<a href=#833 id=833 data-nosnippet>833</a>/// }
|
|
<a href=#834 id=834 data-nosnippet>834</a>/// ```
|
|
<a href=#835 id=835 data-nosnippet>835</a>///
|
|
<a href=#836 id=836 data-nosnippet>836</a>/// [method.log]: trait.Log.html#tymethod.log
|
|
<a href=#837 id=837 data-nosnippet>837</a>/// [`Log`]: trait.Log.html
|
|
<a href=#838 id=838 data-nosnippet>838</a>/// [`log!`]: macro.log.html
|
|
<a href=#839 id=839 data-nosnippet>839</a>/// [`level()`]: struct.Record.html#method.level
|
|
<a href=#840 id=840 data-nosnippet>840</a>/// [`target()`]: struct.Record.html#method.target
|
|
<a href=#841 id=841 data-nosnippet>841</a></span><span class="attr">#[derive(Clone, Debug)]
|
|
<a href=#842 id=842 data-nosnippet>842</a></span><span class="kw">pub struct </span>Record<<span class="lifetime">'a</span>> {
|
|
<a href=#843 id=843 data-nosnippet>843</a> metadata: Metadata<<span class="lifetime">'a</span>>,
|
|
<a href=#844 id=844 data-nosnippet>844</a> args: fmt::Arguments<<span class="lifetime">'a</span>>,
|
|
<a href=#845 id=845 data-nosnippet>845</a> module_path: <span class="prelude-ty">Option</span><MaybeStaticStr<<span class="lifetime">'a</span>>>,
|
|
<a href=#846 id=846 data-nosnippet>846</a> file: <span class="prelude-ty">Option</span><MaybeStaticStr<<span class="lifetime">'a</span>>>,
|
|
<a href=#847 id=847 data-nosnippet>847</a> line: <span class="prelude-ty">Option</span><u32>,
|
|
<a href=#848 id=848 data-nosnippet>848</a> <span class="attr">#[cfg(feature = <span class="string">"kv"</span>)]
|
|
<a href=#849 id=849 data-nosnippet>849</a> </span>key_values: KeyValues<<span class="lifetime">'a</span>>,
|
|
<a href=#850 id=850 data-nosnippet>850</a>}
|
|
<a href=#851 id=851 data-nosnippet>851</a>
|
|
<a href=#852 id=852 data-nosnippet>852</a><span class="comment">// This wrapper type is only needed so we can
|
|
<a href=#853 id=853 data-nosnippet>853</a>// `#[derive(Debug)]` on `Record`. It also
|
|
<a href=#854 id=854 data-nosnippet>854</a>// provides a useful `Debug` implementation for
|
|
<a href=#855 id=855 data-nosnippet>855</a>// the underlying `Source`.
|
|
<a href=#856 id=856 data-nosnippet>856</a></span><span class="attr">#[cfg(feature = <span class="string">"kv"</span>)]
|
|
<a href=#857 id=857 data-nosnippet>857</a>#[derive(Clone)]
|
|
<a href=#858 id=858 data-nosnippet>858</a></span><span class="kw">struct </span>KeyValues<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw">dyn </span>kv::Source);
|
|
<a href=#859 id=859 data-nosnippet>859</a>
|
|
<a href=#860 id=860 data-nosnippet>860</a><span class="attr">#[cfg(feature = <span class="string">"kv"</span>)]
|
|
<a href=#861 id=861 data-nosnippet>861</a></span><span class="kw">impl</span><<span class="lifetime">'a</span>> fmt::Debug <span class="kw">for </span>KeyValues<<span class="lifetime">'a</span>> {
|
|
<a href=#862 id=862 data-nosnippet>862</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result {
|
|
<a href=#863 id=863 data-nosnippet>863</a> <span class="kw">let </span><span class="kw-2">mut </span>visitor = f.debug_map();
|
|
<a href=#864 id=864 data-nosnippet>864</a> <span class="self">self</span>.<span class="number">0</span>.visit(<span class="kw-2">&mut </span>visitor).map_err(|<span class="kw">_</span>| fmt::Error)<span class="question-mark">?</span>;
|
|
<a href=#865 id=865 data-nosnippet>865</a> visitor.finish()
|
|
<a href=#866 id=866 data-nosnippet>866</a> }
|
|
<a href=#867 id=867 data-nosnippet>867</a>}
|
|
<a href=#868 id=868 data-nosnippet>868</a>
|
|
<a href=#869 id=869 data-nosnippet>869</a><span class="kw">impl</span><<span class="lifetime">'a</span>> Record<<span class="lifetime">'a</span>> {
|
|
<a href=#870 id=870 data-nosnippet>870</a> <span class="doccomment">/// Returns a new builder.
|
|
<a href=#871 id=871 data-nosnippet>871</a> </span><span class="attr">#[inline]
|
|
<a href=#872 id=872 data-nosnippet>872</a> </span><span class="kw">pub fn </span>builder() -> RecordBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#873 id=873 data-nosnippet>873</a> RecordBuilder::new()
|
|
<a href=#874 id=874 data-nosnippet>874</a> }
|
|
<a href=#875 id=875 data-nosnippet>875</a>
|
|
<a href=#876 id=876 data-nosnippet>876</a> <span class="doccomment">/// The message body.
|
|
<a href=#877 id=877 data-nosnippet>877</a> </span><span class="attr">#[inline]
|
|
<a href=#878 id=878 data-nosnippet>878</a> </span><span class="kw">pub fn </span>args(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>fmt::Arguments<<span class="lifetime">'a</span>> {
|
|
<a href=#879 id=879 data-nosnippet>879</a> <span class="kw-2">&</span><span class="self">self</span>.args
|
|
<a href=#880 id=880 data-nosnippet>880</a> }
|
|
<a href=#881 id=881 data-nosnippet>881</a>
|
|
<a href=#882 id=882 data-nosnippet>882</a> <span class="doccomment">/// Metadata about the log directive.
|
|
<a href=#883 id=883 data-nosnippet>883</a> </span><span class="attr">#[inline]
|
|
<a href=#884 id=884 data-nosnippet>884</a> </span><span class="kw">pub fn </span>metadata(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>Metadata<<span class="lifetime">'a</span>> {
|
|
<a href=#885 id=885 data-nosnippet>885</a> <span class="kw-2">&</span><span class="self">self</span>.metadata
|
|
<a href=#886 id=886 data-nosnippet>886</a> }
|
|
<a href=#887 id=887 data-nosnippet>887</a>
|
|
<a href=#888 id=888 data-nosnippet>888</a> <span class="doccomment">/// The verbosity level of the message.
|
|
<a href=#889 id=889 data-nosnippet>889</a> </span><span class="attr">#[inline]
|
|
<a href=#890 id=890 data-nosnippet>890</a> </span><span class="kw">pub fn </span>level(<span class="kw-2">&</span><span class="self">self</span>) -> Level {
|
|
<a href=#891 id=891 data-nosnippet>891</a> <span class="self">self</span>.metadata.level()
|
|
<a href=#892 id=892 data-nosnippet>892</a> }
|
|
<a href=#893 id=893 data-nosnippet>893</a>
|
|
<a href=#894 id=894 data-nosnippet>894</a> <span class="doccomment">/// The name of the target of the directive.
|
|
<a href=#895 id=895 data-nosnippet>895</a> </span><span class="attr">#[inline]
|
|
<a href=#896 id=896 data-nosnippet>896</a> </span><span class="kw">pub fn </span>target(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'a </span>str {
|
|
<a href=#897 id=897 data-nosnippet>897</a> <span class="self">self</span>.metadata.target()
|
|
<a href=#898 id=898 data-nosnippet>898</a> }
|
|
<a href=#899 id=899 data-nosnippet>899</a>
|
|
<a href=#900 id=900 data-nosnippet>900</a> <span class="doccomment">/// The module path of the message.
|
|
<a href=#901 id=901 data-nosnippet>901</a> </span><span class="attr">#[inline]
|
|
<a href=#902 id=902 data-nosnippet>902</a> </span><span class="kw">pub fn </span>module_path(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>str> {
|
|
<a href=#903 id=903 data-nosnippet>903</a> <span class="self">self</span>.module_path.map(|s| s.get())
|
|
<a href=#904 id=904 data-nosnippet>904</a> }
|
|
<a href=#905 id=905 data-nosnippet>905</a>
|
|
<a href=#906 id=906 data-nosnippet>906</a> <span class="doccomment">/// The module path of the message, if it is a `'static` string.
|
|
<a href=#907 id=907 data-nosnippet>907</a> </span><span class="attr">#[inline]
|
|
<a href=#908 id=908 data-nosnippet>908</a> </span><span class="kw">pub fn </span>module_path_static(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'static </span>str> {
|
|
<a href=#909 id=909 data-nosnippet>909</a> <span class="kw">match </span><span class="self">self</span>.module_path {
|
|
<a href=#910 id=910 data-nosnippet>910</a> <span class="prelude-val">Some</span>(MaybeStaticStr::Static(s)) => <span class="prelude-val">Some</span>(s),
|
|
<a href=#911 id=911 data-nosnippet>911</a> <span class="kw">_ </span>=> <span class="prelude-val">None</span>,
|
|
<a href=#912 id=912 data-nosnippet>912</a> }
|
|
<a href=#913 id=913 data-nosnippet>913</a> }
|
|
<a href=#914 id=914 data-nosnippet>914</a>
|
|
<a href=#915 id=915 data-nosnippet>915</a> <span class="doccomment">/// The source file containing the message.
|
|
<a href=#916 id=916 data-nosnippet>916</a> </span><span class="attr">#[inline]
|
|
<a href=#917 id=917 data-nosnippet>917</a> </span><span class="kw">pub fn </span>file(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>str> {
|
|
<a href=#918 id=918 data-nosnippet>918</a> <span class="self">self</span>.file.map(|s| s.get())
|
|
<a href=#919 id=919 data-nosnippet>919</a> }
|
|
<a href=#920 id=920 data-nosnippet>920</a>
|
|
<a href=#921 id=921 data-nosnippet>921</a> <span class="doccomment">/// The source file containing the message, if it is a `'static` string.
|
|
<a href=#922 id=922 data-nosnippet>922</a> </span><span class="attr">#[inline]
|
|
<a href=#923 id=923 data-nosnippet>923</a> </span><span class="kw">pub fn </span>file_static(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'static </span>str> {
|
|
<a href=#924 id=924 data-nosnippet>924</a> <span class="kw">match </span><span class="self">self</span>.file {
|
|
<a href=#925 id=925 data-nosnippet>925</a> <span class="prelude-val">Some</span>(MaybeStaticStr::Static(s)) => <span class="prelude-val">Some</span>(s),
|
|
<a href=#926 id=926 data-nosnippet>926</a> <span class="kw">_ </span>=> <span class="prelude-val">None</span>,
|
|
<a href=#927 id=927 data-nosnippet>927</a> }
|
|
<a href=#928 id=928 data-nosnippet>928</a> }
|
|
<a href=#929 id=929 data-nosnippet>929</a>
|
|
<a href=#930 id=930 data-nosnippet>930</a> <span class="doccomment">/// The line containing the message.
|
|
<a href=#931 id=931 data-nosnippet>931</a> </span><span class="attr">#[inline]
|
|
<a href=#932 id=932 data-nosnippet>932</a> </span><span class="kw">pub fn </span>line(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><u32> {
|
|
<a href=#933 id=933 data-nosnippet>933</a> <span class="self">self</span>.line
|
|
<a href=#934 id=934 data-nosnippet>934</a> }
|
|
<a href=#935 id=935 data-nosnippet>935</a>
|
|
<a href=#936 id=936 data-nosnippet>936</a> <span class="doccomment">/// The structured key-value pairs associated with the message.
|
|
<a href=#937 id=937 data-nosnippet>937</a> </span><span class="attr">#[cfg(feature = <span class="string">"kv"</span>)]
|
|
<a href=#938 id=938 data-nosnippet>938</a> #[inline]
|
|
<a href=#939 id=939 data-nosnippet>939</a> </span><span class="kw">pub fn </span>key_values(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="kw">dyn </span>kv::Source {
|
|
<a href=#940 id=940 data-nosnippet>940</a> <span class="self">self</span>.key_values.<span class="number">0
|
|
<a href=#941 id=941 data-nosnippet>941</a> </span>}
|
|
<a href=#942 id=942 data-nosnippet>942</a>
|
|
<a href=#943 id=943 data-nosnippet>943</a> <span class="doccomment">/// Create a new [`RecordBuilder`](struct.RecordBuilder.html) based on this record.
|
|
<a href=#944 id=944 data-nosnippet>944</a> </span><span class="attr">#[cfg(feature = <span class="string">"kv"</span>)]
|
|
<a href=#945 id=945 data-nosnippet>945</a> #[inline]
|
|
<a href=#946 id=946 data-nosnippet>946</a> </span><span class="kw">pub fn </span>to_builder(<span class="kw-2">&</span><span class="self">self</span>) -> RecordBuilder<<span class="lifetime">'_</span>> {
|
|
<a href=#947 id=947 data-nosnippet>947</a> RecordBuilder {
|
|
<a href=#948 id=948 data-nosnippet>948</a> record: Record {
|
|
<a href=#949 id=949 data-nosnippet>949</a> metadata: Metadata {
|
|
<a href=#950 id=950 data-nosnippet>950</a> level: <span class="self">self</span>.metadata.level,
|
|
<a href=#951 id=951 data-nosnippet>951</a> target: <span class="self">self</span>.metadata.target,
|
|
<a href=#952 id=952 data-nosnippet>952</a> },
|
|
<a href=#953 id=953 data-nosnippet>953</a> args: <span class="self">self</span>.args,
|
|
<a href=#954 id=954 data-nosnippet>954</a> module_path: <span class="self">self</span>.module_path,
|
|
<a href=#955 id=955 data-nosnippet>955</a> file: <span class="self">self</span>.file,
|
|
<a href=#956 id=956 data-nosnippet>956</a> line: <span class="self">self</span>.line,
|
|
<a href=#957 id=957 data-nosnippet>957</a> key_values: <span class="self">self</span>.key_values.clone(),
|
|
<a href=#958 id=958 data-nosnippet>958</a> },
|
|
<a href=#959 id=959 data-nosnippet>959</a> }
|
|
<a href=#960 id=960 data-nosnippet>960</a> }
|
|
<a href=#961 id=961 data-nosnippet>961</a>}
|
|
<a href=#962 id=962 data-nosnippet>962</a>
|
|
<a href=#963 id=963 data-nosnippet>963</a><span class="doccomment">/// Builder for [`Record`](struct.Record.html).
|
|
<a href=#964 id=964 data-nosnippet>964</a>///
|
|
<a href=#965 id=965 data-nosnippet>965</a>/// Typically should only be used by log library creators or for testing and "shim loggers".
|
|
<a href=#966 id=966 data-nosnippet>966</a>/// The `RecordBuilder` can set the different parameters of `Record` object, and returns
|
|
<a href=#967 id=967 data-nosnippet>967</a>/// the created object when `build` is called.
|
|
<a href=#968 id=968 data-nosnippet>968</a>///
|
|
<a href=#969 id=969 data-nosnippet>969</a>/// # Examples
|
|
<a href=#970 id=970 data-nosnippet>970</a>///
|
|
<a href=#971 id=971 data-nosnippet>971</a>/// ```
|
|
<a href=#972 id=972 data-nosnippet>972</a>/// use log::{Level, Record};
|
|
<a href=#973 id=973 data-nosnippet>973</a>///
|
|
<a href=#974 id=974 data-nosnippet>974</a>/// let record = Record::builder()
|
|
<a href=#975 id=975 data-nosnippet>975</a>/// .args(format_args!("Error!"))
|
|
<a href=#976 id=976 data-nosnippet>976</a>/// .level(Level::Error)
|
|
<a href=#977 id=977 data-nosnippet>977</a>/// .target("myApp")
|
|
<a href=#978 id=978 data-nosnippet>978</a>/// .file(Some("server.rs"))
|
|
<a href=#979 id=979 data-nosnippet>979</a>/// .line(Some(144))
|
|
<a href=#980 id=980 data-nosnippet>980</a>/// .module_path(Some("server"))
|
|
<a href=#981 id=981 data-nosnippet>981</a>/// .build();
|
|
<a href=#982 id=982 data-nosnippet>982</a>/// ```
|
|
<a href=#983 id=983 data-nosnippet>983</a>///
|
|
<a href=#984 id=984 data-nosnippet>984</a>/// Alternatively, use [`MetadataBuilder`](struct.MetadataBuilder.html):
|
|
<a href=#985 id=985 data-nosnippet>985</a>///
|
|
<a href=#986 id=986 data-nosnippet>986</a>/// ```
|
|
<a href=#987 id=987 data-nosnippet>987</a>/// use log::{Record, Level, MetadataBuilder};
|
|
<a href=#988 id=988 data-nosnippet>988</a>///
|
|
<a href=#989 id=989 data-nosnippet>989</a>/// let error_metadata = MetadataBuilder::new()
|
|
<a href=#990 id=990 data-nosnippet>990</a>/// .target("myApp")
|
|
<a href=#991 id=991 data-nosnippet>991</a>/// .level(Level::Error)
|
|
<a href=#992 id=992 data-nosnippet>992</a>/// .build();
|
|
<a href=#993 id=993 data-nosnippet>993</a>///
|
|
<a href=#994 id=994 data-nosnippet>994</a>/// let record = Record::builder()
|
|
<a href=#995 id=995 data-nosnippet>995</a>/// .metadata(error_metadata)
|
|
<a href=#996 id=996 data-nosnippet>996</a>/// .args(format_args!("Error!"))
|
|
<a href=#997 id=997 data-nosnippet>997</a>/// .line(Some(433))
|
|
<a href=#998 id=998 data-nosnippet>998</a>/// .file(Some("app.rs"))
|
|
<a href=#999 id=999 data-nosnippet>999</a>/// .module_path(Some("server"))
|
|
<a href=#1000 id=1000 data-nosnippet>1000</a>/// .build();
|
|
<a href=#1001 id=1001 data-nosnippet>1001</a>/// ```
|
|
<a href=#1002 id=1002 data-nosnippet>1002</a></span><span class="attr">#[derive(Debug)]
|
|
<a href=#1003 id=1003 data-nosnippet>1003</a></span><span class="kw">pub struct </span>RecordBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1004 id=1004 data-nosnippet>1004</a> record: Record<<span class="lifetime">'a</span>>,
|
|
<a href=#1005 id=1005 data-nosnippet>1005</a>}
|
|
<a href=#1006 id=1006 data-nosnippet>1006</a>
|
|
<a href=#1007 id=1007 data-nosnippet>1007</a><span class="kw">impl</span><<span class="lifetime">'a</span>> RecordBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1008 id=1008 data-nosnippet>1008</a> <span class="doccomment">/// Construct new `RecordBuilder`.
|
|
<a href=#1009 id=1009 data-nosnippet>1009</a> ///
|
|
<a href=#1010 id=1010 data-nosnippet>1010</a> /// The default options are:
|
|
<a href=#1011 id=1011 data-nosnippet>1011</a> ///
|
|
<a href=#1012 id=1012 data-nosnippet>1012</a> /// - `args`: [`format_args!("")`]
|
|
<a href=#1013 id=1013 data-nosnippet>1013</a> /// - `metadata`: [`Metadata::builder().build()`]
|
|
<a href=#1014 id=1014 data-nosnippet>1014</a> /// - `module_path`: `None`
|
|
<a href=#1015 id=1015 data-nosnippet>1015</a> /// - `file`: `None`
|
|
<a href=#1016 id=1016 data-nosnippet>1016</a> /// - `line`: `None`
|
|
<a href=#1017 id=1017 data-nosnippet>1017</a> ///
|
|
<a href=#1018 id=1018 data-nosnippet>1018</a> /// [`format_args!("")`]: https://doc.rust-lang.org/std/macro.format_args.html
|
|
<a href=#1019 id=1019 data-nosnippet>1019</a> /// [`Metadata::builder().build()`]: struct.MetadataBuilder.html#method.build
|
|
<a href=#1020 id=1020 data-nosnippet>1020</a> </span><span class="attr">#[inline]
|
|
<a href=#1021 id=1021 data-nosnippet>1021</a> </span><span class="kw">pub fn </span>new() -> RecordBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1022 id=1022 data-nosnippet>1022</a> RecordBuilder {
|
|
<a href=#1023 id=1023 data-nosnippet>1023</a> record: Record {
|
|
<a href=#1024 id=1024 data-nosnippet>1024</a> args: <span class="macro">format_args!</span>(<span class="string">""</span>),
|
|
<a href=#1025 id=1025 data-nosnippet>1025</a> metadata: Metadata::builder().build(),
|
|
<a href=#1026 id=1026 data-nosnippet>1026</a> module_path: <span class="prelude-val">None</span>,
|
|
<a href=#1027 id=1027 data-nosnippet>1027</a> file: <span class="prelude-val">None</span>,
|
|
<a href=#1028 id=1028 data-nosnippet>1028</a> line: <span class="prelude-val">None</span>,
|
|
<a href=#1029 id=1029 data-nosnippet>1029</a> <span class="attr">#[cfg(feature = <span class="string">"kv"</span>)]
|
|
<a href=#1030 id=1030 data-nosnippet>1030</a> </span>key_values: KeyValues(<span class="kw-2">&</span><span class="prelude-val">None</span>::<(kv::Key, kv::Value)>),
|
|
<a href=#1031 id=1031 data-nosnippet>1031</a> },
|
|
<a href=#1032 id=1032 data-nosnippet>1032</a> }
|
|
<a href=#1033 id=1033 data-nosnippet>1033</a> }
|
|
<a href=#1034 id=1034 data-nosnippet>1034</a>
|
|
<a href=#1035 id=1035 data-nosnippet>1035</a> <span class="doccomment">/// Set [`args`](struct.Record.html#method.args).
|
|
<a href=#1036 id=1036 data-nosnippet>1036</a> </span><span class="attr">#[inline]
|
|
<a href=#1037 id=1037 data-nosnippet>1037</a> </span><span class="kw">pub fn </span>args(<span class="kw-2">&mut </span><span class="self">self</span>, args: fmt::Arguments<<span class="lifetime">'a</span>>) -> <span class="kw-2">&mut </span>RecordBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1038 id=1038 data-nosnippet>1038</a> <span class="self">self</span>.record.args = args;
|
|
<a href=#1039 id=1039 data-nosnippet>1039</a> <span class="self">self
|
|
<a href=#1040 id=1040 data-nosnippet>1040</a> </span>}
|
|
<a href=#1041 id=1041 data-nosnippet>1041</a>
|
|
<a href=#1042 id=1042 data-nosnippet>1042</a> <span class="doccomment">/// Set [`metadata`](struct.Record.html#method.metadata). Construct a `Metadata` object with [`MetadataBuilder`](struct.MetadataBuilder.html).
|
|
<a href=#1043 id=1043 data-nosnippet>1043</a> </span><span class="attr">#[inline]
|
|
<a href=#1044 id=1044 data-nosnippet>1044</a> </span><span class="kw">pub fn </span>metadata(<span class="kw-2">&mut </span><span class="self">self</span>, metadata: Metadata<<span class="lifetime">'a</span>>) -> <span class="kw-2">&mut </span>RecordBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1045 id=1045 data-nosnippet>1045</a> <span class="self">self</span>.record.metadata = metadata;
|
|
<a href=#1046 id=1046 data-nosnippet>1046</a> <span class="self">self
|
|
<a href=#1047 id=1047 data-nosnippet>1047</a> </span>}
|
|
<a href=#1048 id=1048 data-nosnippet>1048</a>
|
|
<a href=#1049 id=1049 data-nosnippet>1049</a> <span class="doccomment">/// Set [`Metadata::level`](struct.Metadata.html#method.level).
|
|
<a href=#1050 id=1050 data-nosnippet>1050</a> </span><span class="attr">#[inline]
|
|
<a href=#1051 id=1051 data-nosnippet>1051</a> </span><span class="kw">pub fn </span>level(<span class="kw-2">&mut </span><span class="self">self</span>, level: Level) -> <span class="kw-2">&mut </span>RecordBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1052 id=1052 data-nosnippet>1052</a> <span class="self">self</span>.record.metadata.level = level;
|
|
<a href=#1053 id=1053 data-nosnippet>1053</a> <span class="self">self
|
|
<a href=#1054 id=1054 data-nosnippet>1054</a> </span>}
|
|
<a href=#1055 id=1055 data-nosnippet>1055</a>
|
|
<a href=#1056 id=1056 data-nosnippet>1056</a> <span class="doccomment">/// Set [`Metadata::target`](struct.Metadata.html#method.target)
|
|
<a href=#1057 id=1057 data-nosnippet>1057</a> </span><span class="attr">#[inline]
|
|
<a href=#1058 id=1058 data-nosnippet>1058</a> </span><span class="kw">pub fn </span>target(<span class="kw-2">&mut </span><span class="self">self</span>, target: <span class="kw-2">&</span><span class="lifetime">'a </span>str) -> <span class="kw-2">&mut </span>RecordBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1059 id=1059 data-nosnippet>1059</a> <span class="self">self</span>.record.metadata.target = target;
|
|
<a href=#1060 id=1060 data-nosnippet>1060</a> <span class="self">self
|
|
<a href=#1061 id=1061 data-nosnippet>1061</a> </span>}
|
|
<a href=#1062 id=1062 data-nosnippet>1062</a>
|
|
<a href=#1063 id=1063 data-nosnippet>1063</a> <span class="doccomment">/// Set [`module_path`](struct.Record.html#method.module_path)
|
|
<a href=#1064 id=1064 data-nosnippet>1064</a> </span><span class="attr">#[inline]
|
|
<a href=#1065 id=1065 data-nosnippet>1065</a> </span><span class="kw">pub fn </span>module_path(<span class="kw-2">&mut </span><span class="self">self</span>, path: <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>str>) -> <span class="kw-2">&mut </span>RecordBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1066 id=1066 data-nosnippet>1066</a> <span class="self">self</span>.record.module_path = path.map(MaybeStaticStr::Borrowed);
|
|
<a href=#1067 id=1067 data-nosnippet>1067</a> <span class="self">self
|
|
<a href=#1068 id=1068 data-nosnippet>1068</a> </span>}
|
|
<a href=#1069 id=1069 data-nosnippet>1069</a>
|
|
<a href=#1070 id=1070 data-nosnippet>1070</a> <span class="doccomment">/// Set [`module_path`](struct.Record.html#method.module_path) to a `'static` string
|
|
<a href=#1071 id=1071 data-nosnippet>1071</a> </span><span class="attr">#[inline]
|
|
<a href=#1072 id=1072 data-nosnippet>1072</a> </span><span class="kw">pub fn </span>module_path_static(<span class="kw-2">&mut </span><span class="self">self</span>, path: <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'static </span>str>) -> <span class="kw-2">&mut </span>RecordBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1073 id=1073 data-nosnippet>1073</a> <span class="self">self</span>.record.module_path = path.map(MaybeStaticStr::Static);
|
|
<a href=#1074 id=1074 data-nosnippet>1074</a> <span class="self">self
|
|
<a href=#1075 id=1075 data-nosnippet>1075</a> </span>}
|
|
<a href=#1076 id=1076 data-nosnippet>1076</a>
|
|
<a href=#1077 id=1077 data-nosnippet>1077</a> <span class="doccomment">/// Set [`file`](struct.Record.html#method.file)
|
|
<a href=#1078 id=1078 data-nosnippet>1078</a> </span><span class="attr">#[inline]
|
|
<a href=#1079 id=1079 data-nosnippet>1079</a> </span><span class="kw">pub fn </span>file(<span class="kw-2">&mut </span><span class="self">self</span>, file: <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>str>) -> <span class="kw-2">&mut </span>RecordBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1080 id=1080 data-nosnippet>1080</a> <span class="self">self</span>.record.file = file.map(MaybeStaticStr::Borrowed);
|
|
<a href=#1081 id=1081 data-nosnippet>1081</a> <span class="self">self
|
|
<a href=#1082 id=1082 data-nosnippet>1082</a> </span>}
|
|
<a href=#1083 id=1083 data-nosnippet>1083</a>
|
|
<a href=#1084 id=1084 data-nosnippet>1084</a> <span class="doccomment">/// Set [`file`](struct.Record.html#method.file) to a `'static` string.
|
|
<a href=#1085 id=1085 data-nosnippet>1085</a> </span><span class="attr">#[inline]
|
|
<a href=#1086 id=1086 data-nosnippet>1086</a> </span><span class="kw">pub fn </span>file_static(<span class="kw-2">&mut </span><span class="self">self</span>, file: <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'static </span>str>) -> <span class="kw-2">&mut </span>RecordBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1087 id=1087 data-nosnippet>1087</a> <span class="self">self</span>.record.file = file.map(MaybeStaticStr::Static);
|
|
<a href=#1088 id=1088 data-nosnippet>1088</a> <span class="self">self
|
|
<a href=#1089 id=1089 data-nosnippet>1089</a> </span>}
|
|
<a href=#1090 id=1090 data-nosnippet>1090</a>
|
|
<a href=#1091 id=1091 data-nosnippet>1091</a> <span class="doccomment">/// Set [`line`](struct.Record.html#method.line)
|
|
<a href=#1092 id=1092 data-nosnippet>1092</a> </span><span class="attr">#[inline]
|
|
<a href=#1093 id=1093 data-nosnippet>1093</a> </span><span class="kw">pub fn </span>line(<span class="kw-2">&mut </span><span class="self">self</span>, line: <span class="prelude-ty">Option</span><u32>) -> <span class="kw-2">&mut </span>RecordBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1094 id=1094 data-nosnippet>1094</a> <span class="self">self</span>.record.line = line;
|
|
<a href=#1095 id=1095 data-nosnippet>1095</a> <span class="self">self
|
|
<a href=#1096 id=1096 data-nosnippet>1096</a> </span>}
|
|
<a href=#1097 id=1097 data-nosnippet>1097</a>
|
|
<a href=#1098 id=1098 data-nosnippet>1098</a> <span class="doccomment">/// Set [`key_values`](struct.Record.html#method.key_values)
|
|
<a href=#1099 id=1099 data-nosnippet>1099</a> </span><span class="attr">#[cfg(feature = <span class="string">"kv"</span>)]
|
|
<a href=#1100 id=1100 data-nosnippet>1100</a> #[inline]
|
|
<a href=#1101 id=1101 data-nosnippet>1101</a> </span><span class="kw">pub fn </span>key_values(<span class="kw-2">&mut </span><span class="self">self</span>, kvs: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw">dyn </span>kv::Source) -> <span class="kw-2">&mut </span>RecordBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1102 id=1102 data-nosnippet>1102</a> <span class="self">self</span>.record.key_values = KeyValues(kvs);
|
|
<a href=#1103 id=1103 data-nosnippet>1103</a> <span class="self">self
|
|
<a href=#1104 id=1104 data-nosnippet>1104</a> </span>}
|
|
<a href=#1105 id=1105 data-nosnippet>1105</a>
|
|
<a href=#1106 id=1106 data-nosnippet>1106</a> <span class="doccomment">/// Invoke the builder and return a `Record`
|
|
<a href=#1107 id=1107 data-nosnippet>1107</a> </span><span class="attr">#[inline]
|
|
<a href=#1108 id=1108 data-nosnippet>1108</a> </span><span class="kw">pub fn </span>build(<span class="kw-2">&</span><span class="self">self</span>) -> Record<<span class="lifetime">'a</span>> {
|
|
<a href=#1109 id=1109 data-nosnippet>1109</a> <span class="self">self</span>.record.clone()
|
|
<a href=#1110 id=1110 data-nosnippet>1110</a> }
|
|
<a href=#1111 id=1111 data-nosnippet>1111</a>}
|
|
<a href=#1112 id=1112 data-nosnippet>1112</a>
|
|
<a href=#1113 id=1113 data-nosnippet>1113</a><span class="kw">impl </span>Default <span class="kw">for </span>RecordBuilder<<span class="lifetime">'_</span>> {
|
|
<a href=#1114 id=1114 data-nosnippet>1114</a> <span class="kw">fn </span>default() -> <span class="self">Self </span>{
|
|
<a href=#1115 id=1115 data-nosnippet>1115</a> <span class="self">Self</span>::new()
|
|
<a href=#1116 id=1116 data-nosnippet>1116</a> }
|
|
<a href=#1117 id=1117 data-nosnippet>1117</a>}
|
|
<a href=#1118 id=1118 data-nosnippet>1118</a>
|
|
<a href=#1119 id=1119 data-nosnippet>1119</a><span class="doccomment">/// Metadata about a log message.
|
|
<a href=#1120 id=1120 data-nosnippet>1120</a>///
|
|
<a href=#1121 id=1121 data-nosnippet>1121</a>/// # Use
|
|
<a href=#1122 id=1122 data-nosnippet>1122</a>///
|
|
<a href=#1123 id=1123 data-nosnippet>1123</a>/// `Metadata` structs are created when users of the library use
|
|
<a href=#1124 id=1124 data-nosnippet>1124</a>/// logging macros.
|
|
<a href=#1125 id=1125 data-nosnippet>1125</a>///
|
|
<a href=#1126 id=1126 data-nosnippet>1126</a>/// They are consumed by implementations of the `Log` trait in the
|
|
<a href=#1127 id=1127 data-nosnippet>1127</a>/// `enabled` method.
|
|
<a href=#1128 id=1128 data-nosnippet>1128</a>///
|
|
<a href=#1129 id=1129 data-nosnippet>1129</a>/// `Record`s use `Metadata` to determine the log message's severity
|
|
<a href=#1130 id=1130 data-nosnippet>1130</a>/// and target.
|
|
<a href=#1131 id=1131 data-nosnippet>1131</a>///
|
|
<a href=#1132 id=1132 data-nosnippet>1132</a>/// Users should use the `log_enabled!` macro in their code to avoid
|
|
<a href=#1133 id=1133 data-nosnippet>1133</a>/// constructing expensive log messages.
|
|
<a href=#1134 id=1134 data-nosnippet>1134</a>///
|
|
<a href=#1135 id=1135 data-nosnippet>1135</a>/// # Examples
|
|
<a href=#1136 id=1136 data-nosnippet>1136</a>///
|
|
<a href=#1137 id=1137 data-nosnippet>1137</a>/// ```
|
|
<a href=#1138 id=1138 data-nosnippet>1138</a>/// use log::{Record, Level, Metadata};
|
|
<a href=#1139 id=1139 data-nosnippet>1139</a>///
|
|
<a href=#1140 id=1140 data-nosnippet>1140</a>/// struct MyLogger;
|
|
<a href=#1141 id=1141 data-nosnippet>1141</a>///
|
|
<a href=#1142 id=1142 data-nosnippet>1142</a>/// impl log::Log for MyLogger {
|
|
<a href=#1143 id=1143 data-nosnippet>1143</a>/// fn enabled(&self, metadata: &Metadata) -> bool {
|
|
<a href=#1144 id=1144 data-nosnippet>1144</a>/// metadata.level() <= Level::Info
|
|
<a href=#1145 id=1145 data-nosnippet>1145</a>/// }
|
|
<a href=#1146 id=1146 data-nosnippet>1146</a>///
|
|
<a href=#1147 id=1147 data-nosnippet>1147</a>/// fn log(&self, record: &Record) {
|
|
<a href=#1148 id=1148 data-nosnippet>1148</a>/// if self.enabled(record.metadata()) {
|
|
<a href=#1149 id=1149 data-nosnippet>1149</a>/// println!("{} - {}", record.level(), record.args());
|
|
<a href=#1150 id=1150 data-nosnippet>1150</a>/// }
|
|
<a href=#1151 id=1151 data-nosnippet>1151</a>/// }
|
|
<a href=#1152 id=1152 data-nosnippet>1152</a>/// fn flush(&self) {}
|
|
<a href=#1153 id=1153 data-nosnippet>1153</a>/// }
|
|
<a href=#1154 id=1154 data-nosnippet>1154</a>///
|
|
<a href=#1155 id=1155 data-nosnippet>1155</a>/// # fn main(){}
|
|
<a href=#1156 id=1156 data-nosnippet>1156</a>/// ```
|
|
<a href=#1157 id=1157 data-nosnippet>1157</a></span><span class="attr">#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
|
|
<a href=#1158 id=1158 data-nosnippet>1158</a></span><span class="kw">pub struct </span>Metadata<<span class="lifetime">'a</span>> {
|
|
<a href=#1159 id=1159 data-nosnippet>1159</a> level: Level,
|
|
<a href=#1160 id=1160 data-nosnippet>1160</a> target: <span class="kw-2">&</span><span class="lifetime">'a </span>str,
|
|
<a href=#1161 id=1161 data-nosnippet>1161</a>}
|
|
<a href=#1162 id=1162 data-nosnippet>1162</a>
|
|
<a href=#1163 id=1163 data-nosnippet>1163</a><span class="kw">impl</span><<span class="lifetime">'a</span>> Metadata<<span class="lifetime">'a</span>> {
|
|
<a href=#1164 id=1164 data-nosnippet>1164</a> <span class="doccomment">/// Returns a new builder.
|
|
<a href=#1165 id=1165 data-nosnippet>1165</a> </span><span class="attr">#[inline]
|
|
<a href=#1166 id=1166 data-nosnippet>1166</a> </span><span class="kw">pub fn </span>builder() -> MetadataBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1167 id=1167 data-nosnippet>1167</a> MetadataBuilder::new()
|
|
<a href=#1168 id=1168 data-nosnippet>1168</a> }
|
|
<a href=#1169 id=1169 data-nosnippet>1169</a>
|
|
<a href=#1170 id=1170 data-nosnippet>1170</a> <span class="doccomment">/// The verbosity level of the message.
|
|
<a href=#1171 id=1171 data-nosnippet>1171</a> </span><span class="attr">#[inline]
|
|
<a href=#1172 id=1172 data-nosnippet>1172</a> </span><span class="kw">pub fn </span>level(<span class="kw-2">&</span><span class="self">self</span>) -> Level {
|
|
<a href=#1173 id=1173 data-nosnippet>1173</a> <span class="self">self</span>.level
|
|
<a href=#1174 id=1174 data-nosnippet>1174</a> }
|
|
<a href=#1175 id=1175 data-nosnippet>1175</a>
|
|
<a href=#1176 id=1176 data-nosnippet>1176</a> <span class="doccomment">/// The name of the target of the directive.
|
|
<a href=#1177 id=1177 data-nosnippet>1177</a> </span><span class="attr">#[inline]
|
|
<a href=#1178 id=1178 data-nosnippet>1178</a> </span><span class="kw">pub fn </span>target(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'a </span>str {
|
|
<a href=#1179 id=1179 data-nosnippet>1179</a> <span class="self">self</span>.target
|
|
<a href=#1180 id=1180 data-nosnippet>1180</a> }
|
|
<a href=#1181 id=1181 data-nosnippet>1181</a>}
|
|
<a href=#1182 id=1182 data-nosnippet>1182</a>
|
|
<a href=#1183 id=1183 data-nosnippet>1183</a><span class="doccomment">/// Builder for [`Metadata`](struct.Metadata.html).
|
|
<a href=#1184 id=1184 data-nosnippet>1184</a>///
|
|
<a href=#1185 id=1185 data-nosnippet>1185</a>/// Typically should only be used by log library creators or for testing and "shim loggers".
|
|
<a href=#1186 id=1186 data-nosnippet>1186</a>/// The `MetadataBuilder` can set the different parameters of a `Metadata` object, and returns
|
|
<a href=#1187 id=1187 data-nosnippet>1187</a>/// the created object when `build` is called.
|
|
<a href=#1188 id=1188 data-nosnippet>1188</a>///
|
|
<a href=#1189 id=1189 data-nosnippet>1189</a>/// # Example
|
|
<a href=#1190 id=1190 data-nosnippet>1190</a>///
|
|
<a href=#1191 id=1191 data-nosnippet>1191</a>/// ```
|
|
<a href=#1192 id=1192 data-nosnippet>1192</a>/// let target = "myApp";
|
|
<a href=#1193 id=1193 data-nosnippet>1193</a>/// use log::{Level, MetadataBuilder};
|
|
<a href=#1194 id=1194 data-nosnippet>1194</a>/// let metadata = MetadataBuilder::new()
|
|
<a href=#1195 id=1195 data-nosnippet>1195</a>/// .level(Level::Debug)
|
|
<a href=#1196 id=1196 data-nosnippet>1196</a>/// .target(target)
|
|
<a href=#1197 id=1197 data-nosnippet>1197</a>/// .build();
|
|
<a href=#1198 id=1198 data-nosnippet>1198</a>/// ```
|
|
<a href=#1199 id=1199 data-nosnippet>1199</a></span><span class="attr">#[derive(Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
|
|
<a href=#1200 id=1200 data-nosnippet>1200</a></span><span class="kw">pub struct </span>MetadataBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1201 id=1201 data-nosnippet>1201</a> metadata: Metadata<<span class="lifetime">'a</span>>,
|
|
<a href=#1202 id=1202 data-nosnippet>1202</a>}
|
|
<a href=#1203 id=1203 data-nosnippet>1203</a>
|
|
<a href=#1204 id=1204 data-nosnippet>1204</a><span class="kw">impl</span><<span class="lifetime">'a</span>> MetadataBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1205 id=1205 data-nosnippet>1205</a> <span class="doccomment">/// Construct a new `MetadataBuilder`.
|
|
<a href=#1206 id=1206 data-nosnippet>1206</a> ///
|
|
<a href=#1207 id=1207 data-nosnippet>1207</a> /// The default options are:
|
|
<a href=#1208 id=1208 data-nosnippet>1208</a> ///
|
|
<a href=#1209 id=1209 data-nosnippet>1209</a> /// - `level`: `Level::Info`
|
|
<a href=#1210 id=1210 data-nosnippet>1210</a> /// - `target`: `""`
|
|
<a href=#1211 id=1211 data-nosnippet>1211</a> </span><span class="attr">#[inline]
|
|
<a href=#1212 id=1212 data-nosnippet>1212</a> </span><span class="kw">pub fn </span>new() -> MetadataBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1213 id=1213 data-nosnippet>1213</a> MetadataBuilder {
|
|
<a href=#1214 id=1214 data-nosnippet>1214</a> metadata: Metadata {
|
|
<a href=#1215 id=1215 data-nosnippet>1215</a> level: Level::Info,
|
|
<a href=#1216 id=1216 data-nosnippet>1216</a> target: <span class="string">""</span>,
|
|
<a href=#1217 id=1217 data-nosnippet>1217</a> },
|
|
<a href=#1218 id=1218 data-nosnippet>1218</a> }
|
|
<a href=#1219 id=1219 data-nosnippet>1219</a> }
|
|
<a href=#1220 id=1220 data-nosnippet>1220</a>
|
|
<a href=#1221 id=1221 data-nosnippet>1221</a> <span class="doccomment">/// Setter for [`level`](struct.Metadata.html#method.level).
|
|
<a href=#1222 id=1222 data-nosnippet>1222</a> </span><span class="attr">#[inline]
|
|
<a href=#1223 id=1223 data-nosnippet>1223</a> </span><span class="kw">pub fn </span>level(<span class="kw-2">&mut </span><span class="self">self</span>, arg: Level) -> <span class="kw-2">&mut </span>MetadataBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1224 id=1224 data-nosnippet>1224</a> <span class="self">self</span>.metadata.level = arg;
|
|
<a href=#1225 id=1225 data-nosnippet>1225</a> <span class="self">self
|
|
<a href=#1226 id=1226 data-nosnippet>1226</a> </span>}
|
|
<a href=#1227 id=1227 data-nosnippet>1227</a>
|
|
<a href=#1228 id=1228 data-nosnippet>1228</a> <span class="doccomment">/// Setter for [`target`](struct.Metadata.html#method.target).
|
|
<a href=#1229 id=1229 data-nosnippet>1229</a> </span><span class="attr">#[inline]
|
|
<a href=#1230 id=1230 data-nosnippet>1230</a> </span><span class="kw">pub fn </span>target(<span class="kw-2">&mut </span><span class="self">self</span>, target: <span class="kw-2">&</span><span class="lifetime">'a </span>str) -> <span class="kw-2">&mut </span>MetadataBuilder<<span class="lifetime">'a</span>> {
|
|
<a href=#1231 id=1231 data-nosnippet>1231</a> <span class="self">self</span>.metadata.target = target;
|
|
<a href=#1232 id=1232 data-nosnippet>1232</a> <span class="self">self
|
|
<a href=#1233 id=1233 data-nosnippet>1233</a> </span>}
|
|
<a href=#1234 id=1234 data-nosnippet>1234</a>
|
|
<a href=#1235 id=1235 data-nosnippet>1235</a> <span class="doccomment">/// Returns a `Metadata` object.
|
|
<a href=#1236 id=1236 data-nosnippet>1236</a> </span><span class="attr">#[inline]
|
|
<a href=#1237 id=1237 data-nosnippet>1237</a> </span><span class="kw">pub fn </span>build(<span class="kw-2">&</span><span class="self">self</span>) -> Metadata<<span class="lifetime">'a</span>> {
|
|
<a href=#1238 id=1238 data-nosnippet>1238</a> <span class="self">self</span>.metadata.clone()
|
|
<a href=#1239 id=1239 data-nosnippet>1239</a> }
|
|
<a href=#1240 id=1240 data-nosnippet>1240</a>}
|
|
<a href=#1241 id=1241 data-nosnippet>1241</a>
|
|
<a href=#1242 id=1242 data-nosnippet>1242</a><span class="kw">impl </span>Default <span class="kw">for </span>MetadataBuilder<<span class="lifetime">'_</span>> {
|
|
<a href=#1243 id=1243 data-nosnippet>1243</a> <span class="kw">fn </span>default() -> <span class="self">Self </span>{
|
|
<a href=#1244 id=1244 data-nosnippet>1244</a> <span class="self">Self</span>::new()
|
|
<a href=#1245 id=1245 data-nosnippet>1245</a> }
|
|
<a href=#1246 id=1246 data-nosnippet>1246</a>}
|
|
<a href=#1247 id=1247 data-nosnippet>1247</a>
|
|
<a href=#1248 id=1248 data-nosnippet>1248</a><span class="doccomment">/// A trait encapsulating the operations required of a logger.
|
|
<a href=#1249 id=1249 data-nosnippet>1249</a></span><span class="kw">pub trait </span>Log: Sync + Send {
|
|
<a href=#1250 id=1250 data-nosnippet>1250</a> <span class="doccomment">/// Determines if a log message with the specified metadata would be
|
|
<a href=#1251 id=1251 data-nosnippet>1251</a> /// logged.
|
|
<a href=#1252 id=1252 data-nosnippet>1252</a> ///
|
|
<a href=#1253 id=1253 data-nosnippet>1253</a> /// This is used by the `log_enabled!` macro to allow callers to avoid
|
|
<a href=#1254 id=1254 data-nosnippet>1254</a> /// expensive computation of log message arguments if the message would be
|
|
<a href=#1255 id=1255 data-nosnippet>1255</a> /// discarded anyway.
|
|
<a href=#1256 id=1256 data-nosnippet>1256</a> ///
|
|
<a href=#1257 id=1257 data-nosnippet>1257</a> /// # For implementors
|
|
<a href=#1258 id=1258 data-nosnippet>1258</a> ///
|
|
<a href=#1259 id=1259 data-nosnippet>1259</a> /// This method isn't called automatically by the `log!` macros.
|
|
<a href=#1260 id=1260 data-nosnippet>1260</a> /// It's up to an implementation of the `Log` trait to call `enabled` in its own
|
|
<a href=#1261 id=1261 data-nosnippet>1261</a> /// `log` method implementation to guarantee that filtering is applied.
|
|
<a href=#1262 id=1262 data-nosnippet>1262</a> </span><span class="kw">fn </span>enabled(<span class="kw-2">&</span><span class="self">self</span>, metadata: <span class="kw-2">&</span>Metadata) -> bool;
|
|
<a href=#1263 id=1263 data-nosnippet>1263</a>
|
|
<a href=#1264 id=1264 data-nosnippet>1264</a> <span class="doccomment">/// Logs the `Record`.
|
|
<a href=#1265 id=1265 data-nosnippet>1265</a> ///
|
|
<a href=#1266 id=1266 data-nosnippet>1266</a> /// # For implementors
|
|
<a href=#1267 id=1267 data-nosnippet>1267</a> ///
|
|
<a href=#1268 id=1268 data-nosnippet>1268</a> /// Note that `enabled` is *not* necessarily called before this method.
|
|
<a href=#1269 id=1269 data-nosnippet>1269</a> /// Implementations of `log` should perform all necessary filtering
|
|
<a href=#1270 id=1270 data-nosnippet>1270</a> /// internally.
|
|
<a href=#1271 id=1271 data-nosnippet>1271</a> </span><span class="kw">fn </span>log(<span class="kw-2">&</span><span class="self">self</span>, record: <span class="kw-2">&</span>Record);
|
|
<a href=#1272 id=1272 data-nosnippet>1272</a>
|
|
<a href=#1273 id=1273 data-nosnippet>1273</a> <span class="doccomment">/// Flushes any buffered records.
|
|
<a href=#1274 id=1274 data-nosnippet>1274</a> ///
|
|
<a href=#1275 id=1275 data-nosnippet>1275</a> /// # For implementors
|
|
<a href=#1276 id=1276 data-nosnippet>1276</a> ///
|
|
<a href=#1277 id=1277 data-nosnippet>1277</a> /// This method isn't called automatically by the `log!` macros.
|
|
<a href=#1278 id=1278 data-nosnippet>1278</a> /// It can be called manually on shut-down to ensure any in-flight records are flushed.
|
|
<a href=#1279 id=1279 data-nosnippet>1279</a> </span><span class="kw">fn </span>flush(<span class="kw-2">&</span><span class="self">self</span>);
|
|
<a href=#1280 id=1280 data-nosnippet>1280</a>}
|
|
<a href=#1281 id=1281 data-nosnippet>1281</a>
|
|
<a href=#1282 id=1282 data-nosnippet>1282</a><span class="doccomment">/// A dummy initial value for LOGGER.
|
|
<a href=#1283 id=1283 data-nosnippet>1283</a></span><span class="kw">struct </span>NopLogger;
|
|
<a href=#1284 id=1284 data-nosnippet>1284</a>
|
|
<a href=#1285 id=1285 data-nosnippet>1285</a><span class="kw">impl </span>Log <span class="kw">for </span>NopLogger {
|
|
<a href=#1286 id=1286 data-nosnippet>1286</a> <span class="kw">fn </span>enabled(<span class="kw-2">&</span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&</span>Metadata) -> bool {
|
|
<a href=#1287 id=1287 data-nosnippet>1287</a> <span class="bool-val">false
|
|
<a href=#1288 id=1288 data-nosnippet>1288</a> </span>}
|
|
<a href=#1289 id=1289 data-nosnippet>1289</a>
|
|
<a href=#1290 id=1290 data-nosnippet>1290</a> <span class="kw">fn </span>log(<span class="kw-2">&</span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&</span>Record) {}
|
|
<a href=#1291 id=1291 data-nosnippet>1291</a> <span class="kw">fn </span>flush(<span class="kw-2">&</span><span class="self">self</span>) {}
|
|
<a href=#1292 id=1292 data-nosnippet>1292</a>}
|
|
<a href=#1293 id=1293 data-nosnippet>1293</a>
|
|
<a href=#1294 id=1294 data-nosnippet>1294</a><span class="kw">impl</span><T> Log <span class="kw">for </span><span class="kw-2">&</span><span class="lifetime">'_ </span>T
|
|
<a href=#1295 id=1295 data-nosnippet>1295</a><span class="kw">where
|
|
<a href=#1296 id=1296 data-nosnippet>1296</a> </span>T: <span class="question-mark">?</span>Sized + Log,
|
|
<a href=#1297 id=1297 data-nosnippet>1297</a>{
|
|
<a href=#1298 id=1298 data-nosnippet>1298</a> <span class="kw">fn </span>enabled(<span class="kw-2">&</span><span class="self">self</span>, metadata: <span class="kw-2">&</span>Metadata) -> bool {
|
|
<a href=#1299 id=1299 data-nosnippet>1299</a> (<span class="kw-2">**</span><span class="self">self</span>).enabled(metadata)
|
|
<a href=#1300 id=1300 data-nosnippet>1300</a> }
|
|
<a href=#1301 id=1301 data-nosnippet>1301</a>
|
|
<a href=#1302 id=1302 data-nosnippet>1302</a> <span class="kw">fn </span>log(<span class="kw-2">&</span><span class="self">self</span>, record: <span class="kw-2">&</span>Record) {
|
|
<a href=#1303 id=1303 data-nosnippet>1303</a> (<span class="kw-2">**</span><span class="self">self</span>).log(record);
|
|
<a href=#1304 id=1304 data-nosnippet>1304</a> }
|
|
<a href=#1305 id=1305 data-nosnippet>1305</a> <span class="kw">fn </span>flush(<span class="kw-2">&</span><span class="self">self</span>) {
|
|
<a href=#1306 id=1306 data-nosnippet>1306</a> (<span class="kw-2">**</span><span class="self">self</span>).flush();
|
|
<a href=#1307 id=1307 data-nosnippet>1307</a> }
|
|
<a href=#1308 id=1308 data-nosnippet>1308</a>}
|
|
<a href=#1309 id=1309 data-nosnippet>1309</a>
|
|
<a href=#1310 id=1310 data-nosnippet>1310</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#1311 id=1311 data-nosnippet>1311</a></span><span class="kw">impl</span><T> Log <span class="kw">for </span>std::boxed::Box<T>
|
|
<a href=#1312 id=1312 data-nosnippet>1312</a><span class="kw">where
|
|
<a href=#1313 id=1313 data-nosnippet>1313</a> </span>T: <span class="question-mark">?</span>Sized + Log,
|
|
<a href=#1314 id=1314 data-nosnippet>1314</a>{
|
|
<a href=#1315 id=1315 data-nosnippet>1315</a> <span class="kw">fn </span>enabled(<span class="kw-2">&</span><span class="self">self</span>, metadata: <span class="kw-2">&</span>Metadata) -> bool {
|
|
<a href=#1316 id=1316 data-nosnippet>1316</a> <span class="self">self</span>.as_ref().enabled(metadata)
|
|
<a href=#1317 id=1317 data-nosnippet>1317</a> }
|
|
<a href=#1318 id=1318 data-nosnippet>1318</a>
|
|
<a href=#1319 id=1319 data-nosnippet>1319</a> <span class="kw">fn </span>log(<span class="kw-2">&</span><span class="self">self</span>, record: <span class="kw-2">&</span>Record) {
|
|
<a href=#1320 id=1320 data-nosnippet>1320</a> <span class="self">self</span>.as_ref().log(record);
|
|
<a href=#1321 id=1321 data-nosnippet>1321</a> }
|
|
<a href=#1322 id=1322 data-nosnippet>1322</a> <span class="kw">fn </span>flush(<span class="kw-2">&</span><span class="self">self</span>) {
|
|
<a href=#1323 id=1323 data-nosnippet>1323</a> <span class="self">self</span>.as_ref().flush();
|
|
<a href=#1324 id=1324 data-nosnippet>1324</a> }
|
|
<a href=#1325 id=1325 data-nosnippet>1325</a>}
|
|
<a href=#1326 id=1326 data-nosnippet>1326</a>
|
|
<a href=#1327 id=1327 data-nosnippet>1327</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#1328 id=1328 data-nosnippet>1328</a></span><span class="kw">impl</span><T> Log <span class="kw">for </span>std::sync::Arc<T>
|
|
<a href=#1329 id=1329 data-nosnippet>1329</a><span class="kw">where
|
|
<a href=#1330 id=1330 data-nosnippet>1330</a> </span>T: <span class="question-mark">?</span>Sized + Log,
|
|
<a href=#1331 id=1331 data-nosnippet>1331</a>{
|
|
<a href=#1332 id=1332 data-nosnippet>1332</a> <span class="kw">fn </span>enabled(<span class="kw-2">&</span><span class="self">self</span>, metadata: <span class="kw-2">&</span>Metadata) -> bool {
|
|
<a href=#1333 id=1333 data-nosnippet>1333</a> <span class="self">self</span>.as_ref().enabled(metadata)
|
|
<a href=#1334 id=1334 data-nosnippet>1334</a> }
|
|
<a href=#1335 id=1335 data-nosnippet>1335</a>
|
|
<a href=#1336 id=1336 data-nosnippet>1336</a> <span class="kw">fn </span>log(<span class="kw-2">&</span><span class="self">self</span>, record: <span class="kw-2">&</span>Record) {
|
|
<a href=#1337 id=1337 data-nosnippet>1337</a> <span class="self">self</span>.as_ref().log(record);
|
|
<a href=#1338 id=1338 data-nosnippet>1338</a> }
|
|
<a href=#1339 id=1339 data-nosnippet>1339</a> <span class="kw">fn </span>flush(<span class="kw-2">&</span><span class="self">self</span>) {
|
|
<a href=#1340 id=1340 data-nosnippet>1340</a> <span class="self">self</span>.as_ref().flush();
|
|
<a href=#1341 id=1341 data-nosnippet>1341</a> }
|
|
<a href=#1342 id=1342 data-nosnippet>1342</a>}
|
|
<a href=#1343 id=1343 data-nosnippet>1343</a>
|
|
<a href=#1344 id=1344 data-nosnippet>1344</a><span class="doccomment">/// Sets the global maximum log level.
|
|
<a href=#1345 id=1345 data-nosnippet>1345</a>///
|
|
<a href=#1346 id=1346 data-nosnippet>1346</a>/// Generally, this should only be called by the active logging implementation.
|
|
<a href=#1347 id=1347 data-nosnippet>1347</a>///
|
|
<a href=#1348 id=1348 data-nosnippet>1348</a>/// Note that `Trace` is the maximum level, because it provides the maximum amount of detail in the emitted logs.
|
|
<a href=#1349 id=1349 data-nosnippet>1349</a></span><span class="attr">#[inline]
|
|
<a href=#1350 id=1350 data-nosnippet>1350</a>#[cfg(target_has_atomic = <span class="string">"ptr"</span>)]
|
|
<a href=#1351 id=1351 data-nosnippet>1351</a></span><span class="kw">pub fn </span>set_max_level(level: LevelFilter) {
|
|
<a href=#1352 id=1352 data-nosnippet>1352</a> MAX_LOG_LEVEL_FILTER.store(level <span class="kw">as </span>usize, Ordering::Relaxed);
|
|
<a href=#1353 id=1353 data-nosnippet>1353</a>}
|
|
<a href=#1354 id=1354 data-nosnippet>1354</a>
|
|
<a href=#1355 id=1355 data-nosnippet>1355</a><span class="doccomment">/// A thread-unsafe version of [`set_max_level`].
|
|
<a href=#1356 id=1356 data-nosnippet>1356</a>///
|
|
<a href=#1357 id=1357 data-nosnippet>1357</a>/// This function is available on all platforms, even those that do not have
|
|
<a href=#1358 id=1358 data-nosnippet>1358</a>/// support for atomics that is needed by [`set_max_level`].
|
|
<a href=#1359 id=1359 data-nosnippet>1359</a>///
|
|
<a href=#1360 id=1360 data-nosnippet>1360</a>/// In almost all cases, [`set_max_level`] should be preferred.
|
|
<a href=#1361 id=1361 data-nosnippet>1361</a>///
|
|
<a href=#1362 id=1362 data-nosnippet>1362</a>/// # Safety
|
|
<a href=#1363 id=1363 data-nosnippet>1363</a>///
|
|
<a href=#1364 id=1364 data-nosnippet>1364</a>/// This function is only safe to call when it cannot race with any other
|
|
<a href=#1365 id=1365 data-nosnippet>1365</a>/// calls to `set_max_level` or `set_max_level_racy`.
|
|
<a href=#1366 id=1366 data-nosnippet>1366</a>///
|
|
<a href=#1367 id=1367 data-nosnippet>1367</a>/// This can be upheld by (for example) making sure that **there are no other
|
|
<a href=#1368 id=1368 data-nosnippet>1368</a>/// threads**, and (on embedded) that **interrupts are disabled**.
|
|
<a href=#1369 id=1369 data-nosnippet>1369</a>///
|
|
<a href=#1370 id=1370 data-nosnippet>1370</a>/// It is safe to use all other logging functions while this function runs
|
|
<a href=#1371 id=1371 data-nosnippet>1371</a>/// (including all logging macros).
|
|
<a href=#1372 id=1372 data-nosnippet>1372</a>///
|
|
<a href=#1373 id=1373 data-nosnippet>1373</a>/// [`set_max_level`]: fn.set_max_level.html
|
|
<a href=#1374 id=1374 data-nosnippet>1374</a></span><span class="attr">#[inline]
|
|
<a href=#1375 id=1375 data-nosnippet>1375</a></span><span class="kw">pub unsafe fn </span>set_max_level_racy(level: LevelFilter) {
|
|
<a href=#1376 id=1376 data-nosnippet>1376</a> <span class="comment">// `MAX_LOG_LEVEL_FILTER` uses a `Cell` as the underlying primitive when a
|
|
<a href=#1377 id=1377 data-nosnippet>1377</a> // platform doesn't support `target_has_atomic = "ptr"`, so even though this looks the same
|
|
<a href=#1378 id=1378 data-nosnippet>1378</a> // as `set_max_level` it may have different safety properties.
|
|
<a href=#1379 id=1379 data-nosnippet>1379</a> </span>MAX_LOG_LEVEL_FILTER.store(level <span class="kw">as </span>usize, Ordering::Relaxed);
|
|
<a href=#1380 id=1380 data-nosnippet>1380</a>}
|
|
<a href=#1381 id=1381 data-nosnippet>1381</a>
|
|
<a href=#1382 id=1382 data-nosnippet>1382</a><span class="doccomment">/// Returns the current maximum log level.
|
|
<a href=#1383 id=1383 data-nosnippet>1383</a>///
|
|
<a href=#1384 id=1384 data-nosnippet>1384</a>/// The [`log!`], [`error!`], [`warn!`], [`info!`], [`debug!`], and [`trace!`] macros check
|
|
<a href=#1385 id=1385 data-nosnippet>1385</a>/// this value and discard any message logged at a higher level. The maximum
|
|
<a href=#1386 id=1386 data-nosnippet>1386</a>/// log level is set by the [`set_max_level`] function.
|
|
<a href=#1387 id=1387 data-nosnippet>1387</a>///
|
|
<a href=#1388 id=1388 data-nosnippet>1388</a>/// [`log!`]: macro.log.html
|
|
<a href=#1389 id=1389 data-nosnippet>1389</a>/// [`error!`]: macro.error.html
|
|
<a href=#1390 id=1390 data-nosnippet>1390</a>/// [`warn!`]: macro.warn.html
|
|
<a href=#1391 id=1391 data-nosnippet>1391</a>/// [`info!`]: macro.info.html
|
|
<a href=#1392 id=1392 data-nosnippet>1392</a>/// [`debug!`]: macro.debug.html
|
|
<a href=#1393 id=1393 data-nosnippet>1393</a>/// [`trace!`]: macro.trace.html
|
|
<a href=#1394 id=1394 data-nosnippet>1394</a>/// [`set_max_level`]: fn.set_max_level.html
|
|
<a href=#1395 id=1395 data-nosnippet>1395</a></span><span class="attr">#[inline(always)]
|
|
<a href=#1396 id=1396 data-nosnippet>1396</a></span><span class="kw">pub fn </span>max_level() -> LevelFilter {
|
|
<a href=#1397 id=1397 data-nosnippet>1397</a> <span class="comment">// Since `LevelFilter` is `repr(usize)`,
|
|
<a href=#1398 id=1398 data-nosnippet>1398</a> // this transmute is sound if and only if `MAX_LOG_LEVEL_FILTER`
|
|
<a href=#1399 id=1399 data-nosnippet>1399</a> // is set to a usize that is a valid discriminant for `LevelFilter`.
|
|
<a href=#1400 id=1400 data-nosnippet>1400</a> // Since `MAX_LOG_LEVEL_FILTER` is private, the only time it's set
|
|
<a href=#1401 id=1401 data-nosnippet>1401</a> // is by `set_max_level` above, i.e. by casting a `LevelFilter` to `usize`.
|
|
<a href=#1402 id=1402 data-nosnippet>1402</a> // So any usize stored in `MAX_LOG_LEVEL_FILTER` is a valid discriminant.
|
|
<a href=#1403 id=1403 data-nosnippet>1403</a> </span><span class="kw">unsafe </span>{ mem::transmute(MAX_LOG_LEVEL_FILTER.load(Ordering::Relaxed)) }
|
|
<a href=#1404 id=1404 data-nosnippet>1404</a>}
|
|
<a href=#1405 id=1405 data-nosnippet>1405</a>
|
|
<a href=#1406 id=1406 data-nosnippet>1406</a><span class="doccomment">/// Sets the global logger to a `Box<Log>`.
|
|
<a href=#1407 id=1407 data-nosnippet>1407</a>///
|
|
<a href=#1408 id=1408 data-nosnippet>1408</a>/// This is a simple convenience wrapper over `set_logger`, which takes a
|
|
<a href=#1409 id=1409 data-nosnippet>1409</a>/// `Box<Log>` rather than a `&'static Log`. See the documentation for
|
|
<a href=#1410 id=1410 data-nosnippet>1410</a>/// [`set_logger`] for more details.
|
|
<a href=#1411 id=1411 data-nosnippet>1411</a>///
|
|
<a href=#1412 id=1412 data-nosnippet>1412</a>/// Requires the `std` feature.
|
|
<a href=#1413 id=1413 data-nosnippet>1413</a>///
|
|
<a href=#1414 id=1414 data-nosnippet>1414</a>/// # Errors
|
|
<a href=#1415 id=1415 data-nosnippet>1415</a>///
|
|
<a href=#1416 id=1416 data-nosnippet>1416</a>/// An error is returned if a logger has already been set.
|
|
<a href=#1417 id=1417 data-nosnippet>1417</a>///
|
|
<a href=#1418 id=1418 data-nosnippet>1418</a>/// [`set_logger`]: fn.set_logger.html
|
|
<a href=#1419 id=1419 data-nosnippet>1419</a></span><span class="attr">#[cfg(all(feature = <span class="string">"std"</span>, target_has_atomic = <span class="string">"ptr"</span>))]
|
|
<a href=#1420 id=1420 data-nosnippet>1420</a></span><span class="kw">pub fn </span>set_boxed_logger(logger: Box<<span class="kw">dyn </span>Log>) -> <span class="prelude-ty">Result</span><(), SetLoggerError> {
|
|
<a href=#1421 id=1421 data-nosnippet>1421</a> set_logger_inner(|| Box::leak(logger))
|
|
<a href=#1422 id=1422 data-nosnippet>1422</a>}
|
|
<a href=#1423 id=1423 data-nosnippet>1423</a>
|
|
<a href=#1424 id=1424 data-nosnippet>1424</a><span class="doccomment">/// Sets the global logger to a `&'static Log`.
|
|
<a href=#1425 id=1425 data-nosnippet>1425</a>///
|
|
<a href=#1426 id=1426 data-nosnippet>1426</a>/// This function may only be called once in the lifetime of a program. Any log
|
|
<a href=#1427 id=1427 data-nosnippet>1427</a>/// events that occur before the call to `set_logger` completes will be ignored.
|
|
<a href=#1428 id=1428 data-nosnippet>1428</a>///
|
|
<a href=#1429 id=1429 data-nosnippet>1429</a>/// This function does not typically need to be called manually. Logger
|
|
<a href=#1430 id=1430 data-nosnippet>1430</a>/// implementations should provide an initialization method that installs the
|
|
<a href=#1431 id=1431 data-nosnippet>1431</a>/// logger internally.
|
|
<a href=#1432 id=1432 data-nosnippet>1432</a>///
|
|
<a href=#1433 id=1433 data-nosnippet>1433</a>/// # Availability
|
|
<a href=#1434 id=1434 data-nosnippet>1434</a>///
|
|
<a href=#1435 id=1435 data-nosnippet>1435</a>/// This method is available even when the `std` feature is disabled. However,
|
|
<a href=#1436 id=1436 data-nosnippet>1436</a>/// it is currently unavailable on `thumbv6` targets, which lack support for
|
|
<a href=#1437 id=1437 data-nosnippet>1437</a>/// some atomic operations which are used by this function. Even on those
|
|
<a href=#1438 id=1438 data-nosnippet>1438</a>/// targets, [`set_logger_racy`] will be available.
|
|
<a href=#1439 id=1439 data-nosnippet>1439</a>///
|
|
<a href=#1440 id=1440 data-nosnippet>1440</a>/// # Errors
|
|
<a href=#1441 id=1441 data-nosnippet>1441</a>///
|
|
<a href=#1442 id=1442 data-nosnippet>1442</a>/// An error is returned if a logger has already been set.
|
|
<a href=#1443 id=1443 data-nosnippet>1443</a>///
|
|
<a href=#1444 id=1444 data-nosnippet>1444</a>/// # Examples
|
|
<a href=#1445 id=1445 data-nosnippet>1445</a>///
|
|
<a href=#1446 id=1446 data-nosnippet>1446</a>/// ```
|
|
<a href=#1447 id=1447 data-nosnippet>1447</a>/// use log::{error, info, warn, Record, Level, Metadata, LevelFilter};
|
|
<a href=#1448 id=1448 data-nosnippet>1448</a>///
|
|
<a href=#1449 id=1449 data-nosnippet>1449</a>/// static MY_LOGGER: MyLogger = MyLogger;
|
|
<a href=#1450 id=1450 data-nosnippet>1450</a>///
|
|
<a href=#1451 id=1451 data-nosnippet>1451</a>/// struct MyLogger;
|
|
<a href=#1452 id=1452 data-nosnippet>1452</a>///
|
|
<a href=#1453 id=1453 data-nosnippet>1453</a>/// impl log::Log for MyLogger {
|
|
<a href=#1454 id=1454 data-nosnippet>1454</a>/// fn enabled(&self, metadata: &Metadata) -> bool {
|
|
<a href=#1455 id=1455 data-nosnippet>1455</a>/// metadata.level() <= Level::Info
|
|
<a href=#1456 id=1456 data-nosnippet>1456</a>/// }
|
|
<a href=#1457 id=1457 data-nosnippet>1457</a>///
|
|
<a href=#1458 id=1458 data-nosnippet>1458</a>/// fn log(&self, record: &Record) {
|
|
<a href=#1459 id=1459 data-nosnippet>1459</a>/// if self.enabled(record.metadata()) {
|
|
<a href=#1460 id=1460 data-nosnippet>1460</a>/// println!("{} - {}", record.level(), record.args());
|
|
<a href=#1461 id=1461 data-nosnippet>1461</a>/// }
|
|
<a href=#1462 id=1462 data-nosnippet>1462</a>/// }
|
|
<a href=#1463 id=1463 data-nosnippet>1463</a>/// fn flush(&self) {}
|
|
<a href=#1464 id=1464 data-nosnippet>1464</a>/// }
|
|
<a href=#1465 id=1465 data-nosnippet>1465</a>///
|
|
<a href=#1466 id=1466 data-nosnippet>1466</a>/// # fn main(){
|
|
<a href=#1467 id=1467 data-nosnippet>1467</a>/// log::set_logger(&MY_LOGGER).unwrap();
|
|
<a href=#1468 id=1468 data-nosnippet>1468</a>/// log::set_max_level(LevelFilter::Info);
|
|
<a href=#1469 id=1469 data-nosnippet>1469</a>///
|
|
<a href=#1470 id=1470 data-nosnippet>1470</a>/// info!("hello log");
|
|
<a href=#1471 id=1471 data-nosnippet>1471</a>/// warn!("warning");
|
|
<a href=#1472 id=1472 data-nosnippet>1472</a>/// error!("oops");
|
|
<a href=#1473 id=1473 data-nosnippet>1473</a>/// # }
|
|
<a href=#1474 id=1474 data-nosnippet>1474</a>/// ```
|
|
<a href=#1475 id=1475 data-nosnippet>1475</a>///
|
|
<a href=#1476 id=1476 data-nosnippet>1476</a>/// [`set_logger_racy`]: fn.set_logger_racy.html
|
|
<a href=#1477 id=1477 data-nosnippet>1477</a></span><span class="attr">#[cfg(target_has_atomic = <span class="string">"ptr"</span>)]
|
|
<a href=#1478 id=1478 data-nosnippet>1478</a></span><span class="kw">pub fn </span>set_logger(logger: <span class="kw-2">&</span><span class="lifetime">'static </span><span class="kw">dyn </span>Log) -> <span class="prelude-ty">Result</span><(), SetLoggerError> {
|
|
<a href=#1479 id=1479 data-nosnippet>1479</a> set_logger_inner(|| logger)
|
|
<a href=#1480 id=1480 data-nosnippet>1480</a>}
|
|
<a href=#1481 id=1481 data-nosnippet>1481</a>
|
|
<a href=#1482 id=1482 data-nosnippet>1482</a><span class="attr">#[cfg(target_has_atomic = <span class="string">"ptr"</span>)]
|
|
<a href=#1483 id=1483 data-nosnippet>1483</a></span><span class="kw">fn </span>set_logger_inner<F>(make_logger: F) -> <span class="prelude-ty">Result</span><(), SetLoggerError>
|
|
<a href=#1484 id=1484 data-nosnippet>1484</a><span class="kw">where
|
|
<a href=#1485 id=1485 data-nosnippet>1485</a> </span>F: FnOnce() -> <span class="kw-2">&</span><span class="lifetime">'static </span><span class="kw">dyn </span>Log,
|
|
<a href=#1486 id=1486 data-nosnippet>1486</a>{
|
|
<a href=#1487 id=1487 data-nosnippet>1487</a> <span class="kw">match </span>STATE.compare_exchange(
|
|
<a href=#1488 id=1488 data-nosnippet>1488</a> UNINITIALIZED,
|
|
<a href=#1489 id=1489 data-nosnippet>1489</a> INITIALIZING,
|
|
<a href=#1490 id=1490 data-nosnippet>1490</a> Ordering::Acquire,
|
|
<a href=#1491 id=1491 data-nosnippet>1491</a> Ordering::Relaxed,
|
|
<a href=#1492 id=1492 data-nosnippet>1492</a> ) {
|
|
<a href=#1493 id=1493 data-nosnippet>1493</a> <span class="prelude-val">Ok</span>(UNINITIALIZED) => {
|
|
<a href=#1494 id=1494 data-nosnippet>1494</a> <span class="kw">unsafe </span>{
|
|
<a href=#1495 id=1495 data-nosnippet>1495</a> LOGGER = make_logger();
|
|
<a href=#1496 id=1496 data-nosnippet>1496</a> }
|
|
<a href=#1497 id=1497 data-nosnippet>1497</a> STATE.store(INITIALIZED, Ordering::Release);
|
|
<a href=#1498 id=1498 data-nosnippet>1498</a> <span class="prelude-val">Ok</span>(())
|
|
<a href=#1499 id=1499 data-nosnippet>1499</a> }
|
|
<a href=#1500 id=1500 data-nosnippet>1500</a> <span class="prelude-val">Err</span>(INITIALIZING) => {
|
|
<a href=#1501 id=1501 data-nosnippet>1501</a> <span class="kw">while </span>STATE.load(Ordering::Relaxed) == INITIALIZING {
|
|
<a href=#1502 id=1502 data-nosnippet>1502</a> std::hint::spin_loop();
|
|
<a href=#1503 id=1503 data-nosnippet>1503</a> }
|
|
<a href=#1504 id=1504 data-nosnippet>1504</a> <span class="prelude-val">Err</span>(SetLoggerError(()))
|
|
<a href=#1505 id=1505 data-nosnippet>1505</a> }
|
|
<a href=#1506 id=1506 data-nosnippet>1506</a> <span class="kw">_ </span>=> <span class="prelude-val">Err</span>(SetLoggerError(())),
|
|
<a href=#1507 id=1507 data-nosnippet>1507</a> }
|
|
<a href=#1508 id=1508 data-nosnippet>1508</a>}
|
|
<a href=#1509 id=1509 data-nosnippet>1509</a>
|
|
<a href=#1510 id=1510 data-nosnippet>1510</a><span class="doccomment">/// A thread-unsafe version of [`set_logger`].
|
|
<a href=#1511 id=1511 data-nosnippet>1511</a>///
|
|
<a href=#1512 id=1512 data-nosnippet>1512</a>/// This function is available on all platforms, even those that do not have
|
|
<a href=#1513 id=1513 data-nosnippet>1513</a>/// support for atomics that is needed by [`set_logger`].
|
|
<a href=#1514 id=1514 data-nosnippet>1514</a>///
|
|
<a href=#1515 id=1515 data-nosnippet>1515</a>/// In almost all cases, [`set_logger`] should be preferred.
|
|
<a href=#1516 id=1516 data-nosnippet>1516</a>///
|
|
<a href=#1517 id=1517 data-nosnippet>1517</a>/// # Safety
|
|
<a href=#1518 id=1518 data-nosnippet>1518</a>///
|
|
<a href=#1519 id=1519 data-nosnippet>1519</a>/// This function is only safe to call when it cannot race with any other
|
|
<a href=#1520 id=1520 data-nosnippet>1520</a>/// calls to `set_logger` or `set_logger_racy`.
|
|
<a href=#1521 id=1521 data-nosnippet>1521</a>///
|
|
<a href=#1522 id=1522 data-nosnippet>1522</a>/// This can be upheld by (for example) making sure that **there are no other
|
|
<a href=#1523 id=1523 data-nosnippet>1523</a>/// threads**, and (on embedded) that **interrupts are disabled**.
|
|
<a href=#1524 id=1524 data-nosnippet>1524</a>///
|
|
<a href=#1525 id=1525 data-nosnippet>1525</a>/// It is safe to use other logging functions while this function runs
|
|
<a href=#1526 id=1526 data-nosnippet>1526</a>/// (including all logging macros).
|
|
<a href=#1527 id=1527 data-nosnippet>1527</a>///
|
|
<a href=#1528 id=1528 data-nosnippet>1528</a>/// [`set_logger`]: fn.set_logger.html
|
|
<a href=#1529 id=1529 data-nosnippet>1529</a></span><span class="kw">pub unsafe fn </span>set_logger_racy(logger: <span class="kw-2">&</span><span class="lifetime">'static </span><span class="kw">dyn </span>Log) -> <span class="prelude-ty">Result</span><(), SetLoggerError> {
|
|
<a href=#1530 id=1530 data-nosnippet>1530</a> <span class="kw">match </span>STATE.load(Ordering::Acquire) {
|
|
<a href=#1531 id=1531 data-nosnippet>1531</a> UNINITIALIZED => {
|
|
<a href=#1532 id=1532 data-nosnippet>1532</a> LOGGER = logger;
|
|
<a href=#1533 id=1533 data-nosnippet>1533</a> STATE.store(INITIALIZED, Ordering::Release);
|
|
<a href=#1534 id=1534 data-nosnippet>1534</a> <span class="prelude-val">Ok</span>(())
|
|
<a href=#1535 id=1535 data-nosnippet>1535</a> }
|
|
<a href=#1536 id=1536 data-nosnippet>1536</a> INITIALIZING => {
|
|
<a href=#1537 id=1537 data-nosnippet>1537</a> <span class="comment">// This is just plain UB, since we were racing another initialization function
|
|
<a href=#1538 id=1538 data-nosnippet>1538</a> </span><span class="macro">unreachable!</span>(<span class="string">"set_logger_racy must not be used with other initialization functions"</span>)
|
|
<a href=#1539 id=1539 data-nosnippet>1539</a> }
|
|
<a href=#1540 id=1540 data-nosnippet>1540</a> <span class="kw">_ </span>=> <span class="prelude-val">Err</span>(SetLoggerError(())),
|
|
<a href=#1541 id=1541 data-nosnippet>1541</a> }
|
|
<a href=#1542 id=1542 data-nosnippet>1542</a>}
|
|
<a href=#1543 id=1543 data-nosnippet>1543</a>
|
|
<a href=#1544 id=1544 data-nosnippet>1544</a><span class="doccomment">/// The type returned by [`set_logger`] if [`set_logger`] has already been called.
|
|
<a href=#1545 id=1545 data-nosnippet>1545</a>///
|
|
<a href=#1546 id=1546 data-nosnippet>1546</a>/// [`set_logger`]: fn.set_logger.html
|
|
<a href=#1547 id=1547 data-nosnippet>1547</a></span><span class="attr">#[allow(missing_copy_implementations)]
|
|
<a href=#1548 id=1548 data-nosnippet>1548</a>#[derive(Debug)]
|
|
<a href=#1549 id=1549 data-nosnippet>1549</a></span><span class="kw">pub struct </span>SetLoggerError(());
|
|
<a href=#1550 id=1550 data-nosnippet>1550</a>
|
|
<a href=#1551 id=1551 data-nosnippet>1551</a><span class="kw">impl </span>fmt::Display <span class="kw">for </span>SetLoggerError {
|
|
<a href=#1552 id=1552 data-nosnippet>1552</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result {
|
|
<a href=#1553 id=1553 data-nosnippet>1553</a> fmt.write_str(SET_LOGGER_ERROR)
|
|
<a href=#1554 id=1554 data-nosnippet>1554</a> }
|
|
<a href=#1555 id=1555 data-nosnippet>1555</a>}
|
|
<a href=#1556 id=1556 data-nosnippet>1556</a>
|
|
<a href=#1557 id=1557 data-nosnippet>1557</a><span class="comment">// The Error trait is not available in libcore
|
|
<a href=#1558 id=1558 data-nosnippet>1558</a></span><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#1559 id=1559 data-nosnippet>1559</a></span><span class="kw">impl </span>error::Error <span class="kw">for </span>SetLoggerError {}
|
|
<a href=#1560 id=1560 data-nosnippet>1560</a>
|
|
<a href=#1561 id=1561 data-nosnippet>1561</a><span class="doccomment">/// The type returned by [`from_str`] when the string doesn't match any of the log levels.
|
|
<a href=#1562 id=1562 data-nosnippet>1562</a>///
|
|
<a href=#1563 id=1563 data-nosnippet>1563</a>/// [`from_str`]: https://doc.rust-lang.org/std/str/trait.FromStr.html#tymethod.from_str
|
|
<a href=#1564 id=1564 data-nosnippet>1564</a></span><span class="attr">#[allow(missing_copy_implementations)]
|
|
<a href=#1565 id=1565 data-nosnippet>1565</a>#[derive(Debug, PartialEq, Eq)]
|
|
<a href=#1566 id=1566 data-nosnippet>1566</a></span><span class="kw">pub struct </span>ParseLevelError(());
|
|
<a href=#1567 id=1567 data-nosnippet>1567</a>
|
|
<a href=#1568 id=1568 data-nosnippet>1568</a><span class="kw">impl </span>fmt::Display <span class="kw">for </span>ParseLevelError {
|
|
<a href=#1569 id=1569 data-nosnippet>1569</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result {
|
|
<a href=#1570 id=1570 data-nosnippet>1570</a> fmt.write_str(LEVEL_PARSE_ERROR)
|
|
<a href=#1571 id=1571 data-nosnippet>1571</a> }
|
|
<a href=#1572 id=1572 data-nosnippet>1572</a>}
|
|
<a href=#1573 id=1573 data-nosnippet>1573</a>
|
|
<a href=#1574 id=1574 data-nosnippet>1574</a><span class="comment">// The Error trait is not available in libcore
|
|
<a href=#1575 id=1575 data-nosnippet>1575</a></span><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#1576 id=1576 data-nosnippet>1576</a></span><span class="kw">impl </span>error::Error <span class="kw">for </span>ParseLevelError {}
|
|
<a href=#1577 id=1577 data-nosnippet>1577</a>
|
|
<a href=#1578 id=1578 data-nosnippet>1578</a><span class="doccomment">/// Returns a reference to the logger.
|
|
<a href=#1579 id=1579 data-nosnippet>1579</a>///
|
|
<a href=#1580 id=1580 data-nosnippet>1580</a>/// If a logger has not been set, a no-op implementation is returned.
|
|
<a href=#1581 id=1581 data-nosnippet>1581</a></span><span class="kw">pub fn </span>logger() -> <span class="kw-2">&</span><span class="lifetime">'static </span><span class="kw">dyn </span>Log {
|
|
<a href=#1582 id=1582 data-nosnippet>1582</a> <span class="comment">// Acquire memory ordering guarantees that current thread would see any
|
|
<a href=#1583 id=1583 data-nosnippet>1583</a> // memory writes that happened before store of the value
|
|
<a href=#1584 id=1584 data-nosnippet>1584</a> // into `STATE` with memory ordering `Release` or stronger.
|
|
<a href=#1585 id=1585 data-nosnippet>1585</a> //
|
|
<a href=#1586 id=1586 data-nosnippet>1586</a> // Since the value `INITIALIZED` is written only after `LOGGER` was
|
|
<a href=#1587 id=1587 data-nosnippet>1587</a> // initialized, observing it after `Acquire` load here makes both
|
|
<a href=#1588 id=1588 data-nosnippet>1588</a> // write to the `LOGGER` static and initialization of the logger
|
|
<a href=#1589 id=1589 data-nosnippet>1589</a> // internal state synchronized with current thread.
|
|
<a href=#1590 id=1590 data-nosnippet>1590</a> </span><span class="kw">if </span>STATE.load(Ordering::Acquire) != INITIALIZED {
|
|
<a href=#1591 id=1591 data-nosnippet>1591</a> <span class="kw">static </span>NOP: NopLogger = NopLogger;
|
|
<a href=#1592 id=1592 data-nosnippet>1592</a> <span class="kw-2">&</span>NOP
|
|
<a href=#1593 id=1593 data-nosnippet>1593</a> } <span class="kw">else </span>{
|
|
<a href=#1594 id=1594 data-nosnippet>1594</a> <span class="kw">unsafe </span>{ LOGGER }
|
|
<a href=#1595 id=1595 data-nosnippet>1595</a> }
|
|
<a href=#1596 id=1596 data-nosnippet>1596</a>}
|
|
<a href=#1597 id=1597 data-nosnippet>1597</a>
|
|
<a href=#1598 id=1598 data-nosnippet>1598</a><span class="comment">// WARNING: this is not part of the crate's public API and is subject to change at any time
|
|
<a href=#1599 id=1599 data-nosnippet>1599</a></span><span class="attr">#[doc(hidden)]
|
|
<a href=#1600 id=1600 data-nosnippet>1600</a></span><span class="kw">pub mod </span>__private_api;
|
|
<a href=#1601 id=1601 data-nosnippet>1601</a>
|
|
<a href=#1602 id=1602 data-nosnippet>1602</a><span class="doccomment">/// The statically resolved maximum log level.
|
|
<a href=#1603 id=1603 data-nosnippet>1603</a>///
|
|
<a href=#1604 id=1604 data-nosnippet>1604</a>/// See the crate level documentation for information on how to configure this.
|
|
<a href=#1605 id=1605 data-nosnippet>1605</a>///
|
|
<a href=#1606 id=1606 data-nosnippet>1606</a>/// This value is checked by the log macros, but not by the `Log`ger returned by
|
|
<a href=#1607 id=1607 data-nosnippet>1607</a>/// the [`logger`] function. Code that manually calls functions on that value
|
|
<a href=#1608 id=1608 data-nosnippet>1608</a>/// should compare the level against this value.
|
|
<a href=#1609 id=1609 data-nosnippet>1609</a>///
|
|
<a href=#1610 id=1610 data-nosnippet>1610</a>/// [`logger`]: fn.logger.html
|
|
<a href=#1611 id=1611 data-nosnippet>1611</a></span><span class="kw">pub const </span>STATIC_MAX_LEVEL: LevelFilter = <span class="kw">match </span><span class="macro">cfg!</span>(debug_assertions) {
|
|
<a href=#1612 id=1612 data-nosnippet>1612</a> <span class="bool-val">false </span><span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">"release_max_level_off"</span>) => LevelFilter::Off,
|
|
<a href=#1613 id=1613 data-nosnippet>1613</a> <span class="bool-val">false </span><span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">"release_max_level_error"</span>) => LevelFilter::Error,
|
|
<a href=#1614 id=1614 data-nosnippet>1614</a> <span class="bool-val">false </span><span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">"release_max_level_warn"</span>) => LevelFilter::Warn,
|
|
<a href=#1615 id=1615 data-nosnippet>1615</a> <span class="bool-val">false </span><span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">"release_max_level_info"</span>) => LevelFilter::Info,
|
|
<a href=#1616 id=1616 data-nosnippet>1616</a> <span class="bool-val">false </span><span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">"release_max_level_debug"</span>) => LevelFilter::Debug,
|
|
<a href=#1617 id=1617 data-nosnippet>1617</a> <span class="bool-val">false </span><span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">"release_max_level_trace"</span>) => LevelFilter::Trace,
|
|
<a href=#1618 id=1618 data-nosnippet>1618</a> <span class="kw">_ if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_off"</span>) => LevelFilter::Off,
|
|
<a href=#1619 id=1619 data-nosnippet>1619</a> <span class="kw">_ if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_error"</span>) => LevelFilter::Error,
|
|
<a href=#1620 id=1620 data-nosnippet>1620</a> <span class="kw">_ if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_warn"</span>) => LevelFilter::Warn,
|
|
<a href=#1621 id=1621 data-nosnippet>1621</a> <span class="kw">_ if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_info"</span>) => LevelFilter::Info,
|
|
<a href=#1622 id=1622 data-nosnippet>1622</a> <span class="kw">_ if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_debug"</span>) => LevelFilter::Debug,
|
|
<a href=#1623 id=1623 data-nosnippet>1623</a> <span class="kw">_ </span>=> LevelFilter::Trace,
|
|
<a href=#1624 id=1624 data-nosnippet>1624</a>};
|
|
<a href=#1625 id=1625 data-nosnippet>1625</a>
|
|
<a href=#1626 id=1626 data-nosnippet>1626</a><span class="attr">#[cfg(test)]
|
|
<a href=#1627 id=1627 data-nosnippet>1627</a></span><span class="kw">mod </span>tests {
|
|
<a href=#1628 id=1628 data-nosnippet>1628</a> <span class="kw">use super</span>::{Level, LevelFilter, ParseLevelError, STATIC_MAX_LEVEL};
|
|
<a href=#1629 id=1629 data-nosnippet>1629</a>
|
|
<a href=#1630 id=1630 data-nosnippet>1630</a> <span class="attr">#[test]
|
|
<a href=#1631 id=1631 data-nosnippet>1631</a> </span><span class="kw">fn </span>test_levelfilter_from_str() {
|
|
<a href=#1632 id=1632 data-nosnippet>1632</a> <span class="kw">let </span>tests = [
|
|
<a href=#1633 id=1633 data-nosnippet>1633</a> (<span class="string">"off"</span>, <span class="prelude-val">Ok</span>(LevelFilter::Off)),
|
|
<a href=#1634 id=1634 data-nosnippet>1634</a> (<span class="string">"error"</span>, <span class="prelude-val">Ok</span>(LevelFilter::Error)),
|
|
<a href=#1635 id=1635 data-nosnippet>1635</a> (<span class="string">"warn"</span>, <span class="prelude-val">Ok</span>(LevelFilter::Warn)),
|
|
<a href=#1636 id=1636 data-nosnippet>1636</a> (<span class="string">"info"</span>, <span class="prelude-val">Ok</span>(LevelFilter::Info)),
|
|
<a href=#1637 id=1637 data-nosnippet>1637</a> (<span class="string">"debug"</span>, <span class="prelude-val">Ok</span>(LevelFilter::Debug)),
|
|
<a href=#1638 id=1638 data-nosnippet>1638</a> (<span class="string">"trace"</span>, <span class="prelude-val">Ok</span>(LevelFilter::Trace)),
|
|
<a href=#1639 id=1639 data-nosnippet>1639</a> (<span class="string">"OFF"</span>, <span class="prelude-val">Ok</span>(LevelFilter::Off)),
|
|
<a href=#1640 id=1640 data-nosnippet>1640</a> (<span class="string">"ERROR"</span>, <span class="prelude-val">Ok</span>(LevelFilter::Error)),
|
|
<a href=#1641 id=1641 data-nosnippet>1641</a> (<span class="string">"WARN"</span>, <span class="prelude-val">Ok</span>(LevelFilter::Warn)),
|
|
<a href=#1642 id=1642 data-nosnippet>1642</a> (<span class="string">"INFO"</span>, <span class="prelude-val">Ok</span>(LevelFilter::Info)),
|
|
<a href=#1643 id=1643 data-nosnippet>1643</a> (<span class="string">"DEBUG"</span>, <span class="prelude-val">Ok</span>(LevelFilter::Debug)),
|
|
<a href=#1644 id=1644 data-nosnippet>1644</a> (<span class="string">"TRACE"</span>, <span class="prelude-val">Ok</span>(LevelFilter::Trace)),
|
|
<a href=#1645 id=1645 data-nosnippet>1645</a> (<span class="string">"asdf"</span>, <span class="prelude-val">Err</span>(ParseLevelError(()))),
|
|
<a href=#1646 id=1646 data-nosnippet>1646</a> ];
|
|
<a href=#1647 id=1647 data-nosnippet>1647</a> <span class="kw">for </span><span class="kw-2">&</span>(s, <span class="kw-2">ref </span>expected) <span class="kw">in </span><span class="kw-2">&</span>tests {
|
|
<a href=#1648 id=1648 data-nosnippet>1648</a> <span class="macro">assert_eq!</span>(expected, <span class="kw-2">&</span>s.parse());
|
|
<a href=#1649 id=1649 data-nosnippet>1649</a> }
|
|
<a href=#1650 id=1650 data-nosnippet>1650</a> }
|
|
<a href=#1651 id=1651 data-nosnippet>1651</a>
|
|
<a href=#1652 id=1652 data-nosnippet>1652</a> <span class="attr">#[test]
|
|
<a href=#1653 id=1653 data-nosnippet>1653</a> </span><span class="kw">fn </span>test_level_from_str() {
|
|
<a href=#1654 id=1654 data-nosnippet>1654</a> <span class="kw">let </span>tests = [
|
|
<a href=#1655 id=1655 data-nosnippet>1655</a> (<span class="string">"OFF"</span>, <span class="prelude-val">Err</span>(ParseLevelError(()))),
|
|
<a href=#1656 id=1656 data-nosnippet>1656</a> (<span class="string">"error"</span>, <span class="prelude-val">Ok</span>(Level::Error)),
|
|
<a href=#1657 id=1657 data-nosnippet>1657</a> (<span class="string">"warn"</span>, <span class="prelude-val">Ok</span>(Level::Warn)),
|
|
<a href=#1658 id=1658 data-nosnippet>1658</a> (<span class="string">"info"</span>, <span class="prelude-val">Ok</span>(Level::Info)),
|
|
<a href=#1659 id=1659 data-nosnippet>1659</a> (<span class="string">"debug"</span>, <span class="prelude-val">Ok</span>(Level::Debug)),
|
|
<a href=#1660 id=1660 data-nosnippet>1660</a> (<span class="string">"trace"</span>, <span class="prelude-val">Ok</span>(Level::Trace)),
|
|
<a href=#1661 id=1661 data-nosnippet>1661</a> (<span class="string">"ERROR"</span>, <span class="prelude-val">Ok</span>(Level::Error)),
|
|
<a href=#1662 id=1662 data-nosnippet>1662</a> (<span class="string">"WARN"</span>, <span class="prelude-val">Ok</span>(Level::Warn)),
|
|
<a href=#1663 id=1663 data-nosnippet>1663</a> (<span class="string">"INFO"</span>, <span class="prelude-val">Ok</span>(Level::Info)),
|
|
<a href=#1664 id=1664 data-nosnippet>1664</a> (<span class="string">"DEBUG"</span>, <span class="prelude-val">Ok</span>(Level::Debug)),
|
|
<a href=#1665 id=1665 data-nosnippet>1665</a> (<span class="string">"TRACE"</span>, <span class="prelude-val">Ok</span>(Level::Trace)),
|
|
<a href=#1666 id=1666 data-nosnippet>1666</a> (<span class="string">"asdf"</span>, <span class="prelude-val">Err</span>(ParseLevelError(()))),
|
|
<a href=#1667 id=1667 data-nosnippet>1667</a> ];
|
|
<a href=#1668 id=1668 data-nosnippet>1668</a> <span class="kw">for </span><span class="kw-2">&</span>(s, <span class="kw-2">ref </span>expected) <span class="kw">in </span><span class="kw-2">&</span>tests {
|
|
<a href=#1669 id=1669 data-nosnippet>1669</a> <span class="macro">assert_eq!</span>(expected, <span class="kw-2">&</span>s.parse());
|
|
<a href=#1670 id=1670 data-nosnippet>1670</a> }
|
|
<a href=#1671 id=1671 data-nosnippet>1671</a> }
|
|
<a href=#1672 id=1672 data-nosnippet>1672</a>
|
|
<a href=#1673 id=1673 data-nosnippet>1673</a> <span class="attr">#[test]
|
|
<a href=#1674 id=1674 data-nosnippet>1674</a> </span><span class="kw">fn </span>test_level_as_str() {
|
|
<a href=#1675 id=1675 data-nosnippet>1675</a> <span class="kw">let </span>tests = <span class="kw-2">&</span>[
|
|
<a href=#1676 id=1676 data-nosnippet>1676</a> (Level::Error, <span class="string">"ERROR"</span>),
|
|
<a href=#1677 id=1677 data-nosnippet>1677</a> (Level::Warn, <span class="string">"WARN"</span>),
|
|
<a href=#1678 id=1678 data-nosnippet>1678</a> (Level::Info, <span class="string">"INFO"</span>),
|
|
<a href=#1679 id=1679 data-nosnippet>1679</a> (Level::Debug, <span class="string">"DEBUG"</span>),
|
|
<a href=#1680 id=1680 data-nosnippet>1680</a> (Level::Trace, <span class="string">"TRACE"</span>),
|
|
<a href=#1681 id=1681 data-nosnippet>1681</a> ];
|
|
<a href=#1682 id=1682 data-nosnippet>1682</a> <span class="kw">for </span>(input, expected) <span class="kw">in </span>tests {
|
|
<a href=#1683 id=1683 data-nosnippet>1683</a> <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>expected, input.as_str());
|
|
<a href=#1684 id=1684 data-nosnippet>1684</a> }
|
|
<a href=#1685 id=1685 data-nosnippet>1685</a> }
|
|
<a href=#1686 id=1686 data-nosnippet>1686</a>
|
|
<a href=#1687 id=1687 data-nosnippet>1687</a> <span class="attr">#[test]
|
|
<a href=#1688 id=1688 data-nosnippet>1688</a> </span><span class="kw">fn </span>test_level_show() {
|
|
<a href=#1689 id=1689 data-nosnippet>1689</a> <span class="macro">assert_eq!</span>(<span class="string">"INFO"</span>, Level::Info.to_string());
|
|
<a href=#1690 id=1690 data-nosnippet>1690</a> <span class="macro">assert_eq!</span>(<span class="string">"ERROR"</span>, Level::Error.to_string());
|
|
<a href=#1691 id=1691 data-nosnippet>1691</a> }
|
|
<a href=#1692 id=1692 data-nosnippet>1692</a>
|
|
<a href=#1693 id=1693 data-nosnippet>1693</a> <span class="attr">#[test]
|
|
<a href=#1694 id=1694 data-nosnippet>1694</a> </span><span class="kw">fn </span>test_levelfilter_show() {
|
|
<a href=#1695 id=1695 data-nosnippet>1695</a> <span class="macro">assert_eq!</span>(<span class="string">"OFF"</span>, LevelFilter::Off.to_string());
|
|
<a href=#1696 id=1696 data-nosnippet>1696</a> <span class="macro">assert_eq!</span>(<span class="string">"ERROR"</span>, LevelFilter::Error.to_string());
|
|
<a href=#1697 id=1697 data-nosnippet>1697</a> }
|
|
<a href=#1698 id=1698 data-nosnippet>1698</a>
|
|
<a href=#1699 id=1699 data-nosnippet>1699</a> <span class="attr">#[test]
|
|
<a href=#1700 id=1700 data-nosnippet>1700</a> </span><span class="kw">fn </span>test_cross_cmp() {
|
|
<a href=#1701 id=1701 data-nosnippet>1701</a> <span class="macro">assert!</span>(Level::Debug > LevelFilter::Error);
|
|
<a href=#1702 id=1702 data-nosnippet>1702</a> <span class="macro">assert!</span>(LevelFilter::Warn < Level::Trace);
|
|
<a href=#1703 id=1703 data-nosnippet>1703</a> <span class="macro">assert!</span>(LevelFilter::Off < Level::Error);
|
|
<a href=#1704 id=1704 data-nosnippet>1704</a> }
|
|
<a href=#1705 id=1705 data-nosnippet>1705</a>
|
|
<a href=#1706 id=1706 data-nosnippet>1706</a> <span class="attr">#[test]
|
|
<a href=#1707 id=1707 data-nosnippet>1707</a> </span><span class="kw">fn </span>test_cross_eq() {
|
|
<a href=#1708 id=1708 data-nosnippet>1708</a> <span class="macro">assert!</span>(Level::Error == LevelFilter::Error);
|
|
<a href=#1709 id=1709 data-nosnippet>1709</a> <span class="macro">assert!</span>(<span class="macro">LevelFilter::Off !</span>= Level::Error);
|
|
<a href=#1710 id=1710 data-nosnippet>1710</a> <span class="macro">assert!</span>(Level::Trace == LevelFilter::Trace);
|
|
<a href=#1711 id=1711 data-nosnippet>1711</a> }
|
|
<a href=#1712 id=1712 data-nosnippet>1712</a>
|
|
<a href=#1713 id=1713 data-nosnippet>1713</a> <span class="attr">#[test]
|
|
<a href=#1714 id=1714 data-nosnippet>1714</a> </span><span class="kw">fn </span>test_to_level() {
|
|
<a href=#1715 id=1715 data-nosnippet>1715</a> <span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(Level::Error), LevelFilter::Error.to_level());
|
|
<a href=#1716 id=1716 data-nosnippet>1716</a> <span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, LevelFilter::Off.to_level());
|
|
<a href=#1717 id=1717 data-nosnippet>1717</a> <span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(Level::Debug), LevelFilter::Debug.to_level());
|
|
<a href=#1718 id=1718 data-nosnippet>1718</a> }
|
|
<a href=#1719 id=1719 data-nosnippet>1719</a>
|
|
<a href=#1720 id=1720 data-nosnippet>1720</a> <span class="attr">#[test]
|
|
<a href=#1721 id=1721 data-nosnippet>1721</a> </span><span class="kw">fn </span>test_to_level_filter() {
|
|
<a href=#1722 id=1722 data-nosnippet>1722</a> <span class="macro">assert_eq!</span>(LevelFilter::Error, Level::Error.to_level_filter());
|
|
<a href=#1723 id=1723 data-nosnippet>1723</a> <span class="macro">assert_eq!</span>(LevelFilter::Trace, Level::Trace.to_level_filter());
|
|
<a href=#1724 id=1724 data-nosnippet>1724</a> }
|
|
<a href=#1725 id=1725 data-nosnippet>1725</a>
|
|
<a href=#1726 id=1726 data-nosnippet>1726</a> <span class="attr">#[test]
|
|
<a href=#1727 id=1727 data-nosnippet>1727</a> </span><span class="kw">fn </span>test_level_filter_as_str() {
|
|
<a href=#1728 id=1728 data-nosnippet>1728</a> <span class="kw">let </span>tests = <span class="kw-2">&</span>[
|
|
<a href=#1729 id=1729 data-nosnippet>1729</a> (LevelFilter::Off, <span class="string">"OFF"</span>),
|
|
<a href=#1730 id=1730 data-nosnippet>1730</a> (LevelFilter::Error, <span class="string">"ERROR"</span>),
|
|
<a href=#1731 id=1731 data-nosnippet>1731</a> (LevelFilter::Warn, <span class="string">"WARN"</span>),
|
|
<a href=#1732 id=1732 data-nosnippet>1732</a> (LevelFilter::Info, <span class="string">"INFO"</span>),
|
|
<a href=#1733 id=1733 data-nosnippet>1733</a> (LevelFilter::Debug, <span class="string">"DEBUG"</span>),
|
|
<a href=#1734 id=1734 data-nosnippet>1734</a> (LevelFilter::Trace, <span class="string">"TRACE"</span>),
|
|
<a href=#1735 id=1735 data-nosnippet>1735</a> ];
|
|
<a href=#1736 id=1736 data-nosnippet>1736</a> <span class="kw">for </span>(input, expected) <span class="kw">in </span>tests {
|
|
<a href=#1737 id=1737 data-nosnippet>1737</a> <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>expected, input.as_str());
|
|
<a href=#1738 id=1738 data-nosnippet>1738</a> }
|
|
<a href=#1739 id=1739 data-nosnippet>1739</a> }
|
|
<a href=#1740 id=1740 data-nosnippet>1740</a>
|
|
<a href=#1741 id=1741 data-nosnippet>1741</a> <span class="attr">#[test]
|
|
<a href=#1742 id=1742 data-nosnippet>1742</a> </span><span class="kw">fn </span>test_level_up() {
|
|
<a href=#1743 id=1743 data-nosnippet>1743</a> <span class="kw">let </span>info = Level::Info;
|
|
<a href=#1744 id=1744 data-nosnippet>1744</a> <span class="kw">let </span>up = info.increment_severity();
|
|
<a href=#1745 id=1745 data-nosnippet>1745</a> <span class="macro">assert_eq!</span>(up, Level::Debug);
|
|
<a href=#1746 id=1746 data-nosnippet>1746</a>
|
|
<a href=#1747 id=1747 data-nosnippet>1747</a> <span class="kw">let </span>trace = Level::Trace;
|
|
<a href=#1748 id=1748 data-nosnippet>1748</a> <span class="kw">let </span>up = trace.increment_severity();
|
|
<a href=#1749 id=1749 data-nosnippet>1749</a> <span class="comment">// trace is already highest level
|
|
<a href=#1750 id=1750 data-nosnippet>1750</a> </span><span class="macro">assert_eq!</span>(up, trace);
|
|
<a href=#1751 id=1751 data-nosnippet>1751</a> }
|
|
<a href=#1752 id=1752 data-nosnippet>1752</a>
|
|
<a href=#1753 id=1753 data-nosnippet>1753</a> <span class="attr">#[test]
|
|
<a href=#1754 id=1754 data-nosnippet>1754</a> </span><span class="kw">fn </span>test_level_filter_up() {
|
|
<a href=#1755 id=1755 data-nosnippet>1755</a> <span class="kw">let </span>info = LevelFilter::Info;
|
|
<a href=#1756 id=1756 data-nosnippet>1756</a> <span class="kw">let </span>up = info.increment_severity();
|
|
<a href=#1757 id=1757 data-nosnippet>1757</a> <span class="macro">assert_eq!</span>(up, LevelFilter::Debug);
|
|
<a href=#1758 id=1758 data-nosnippet>1758</a>
|
|
<a href=#1759 id=1759 data-nosnippet>1759</a> <span class="kw">let </span>trace = LevelFilter::Trace;
|
|
<a href=#1760 id=1760 data-nosnippet>1760</a> <span class="kw">let </span>up = trace.increment_severity();
|
|
<a href=#1761 id=1761 data-nosnippet>1761</a> <span class="comment">// trace is already highest level
|
|
<a href=#1762 id=1762 data-nosnippet>1762</a> </span><span class="macro">assert_eq!</span>(up, trace);
|
|
<a href=#1763 id=1763 data-nosnippet>1763</a> }
|
|
<a href=#1764 id=1764 data-nosnippet>1764</a>
|
|
<a href=#1765 id=1765 data-nosnippet>1765</a> <span class="attr">#[test]
|
|
<a href=#1766 id=1766 data-nosnippet>1766</a> </span><span class="kw">fn </span>test_level_down() {
|
|
<a href=#1767 id=1767 data-nosnippet>1767</a> <span class="kw">let </span>info = Level::Info;
|
|
<a href=#1768 id=1768 data-nosnippet>1768</a> <span class="kw">let </span>down = info.decrement_severity();
|
|
<a href=#1769 id=1769 data-nosnippet>1769</a> <span class="macro">assert_eq!</span>(down, Level::Warn);
|
|
<a href=#1770 id=1770 data-nosnippet>1770</a>
|
|
<a href=#1771 id=1771 data-nosnippet>1771</a> <span class="kw">let </span>error = Level::Error;
|
|
<a href=#1772 id=1772 data-nosnippet>1772</a> <span class="kw">let </span>down = error.decrement_severity();
|
|
<a href=#1773 id=1773 data-nosnippet>1773</a> <span class="comment">// error is already lowest level
|
|
<a href=#1774 id=1774 data-nosnippet>1774</a> </span><span class="macro">assert_eq!</span>(down, error);
|
|
<a href=#1775 id=1775 data-nosnippet>1775</a> }
|
|
<a href=#1776 id=1776 data-nosnippet>1776</a>
|
|
<a href=#1777 id=1777 data-nosnippet>1777</a> <span class="attr">#[test]
|
|
<a href=#1778 id=1778 data-nosnippet>1778</a> </span><span class="kw">fn </span>test_level_filter_down() {
|
|
<a href=#1779 id=1779 data-nosnippet>1779</a> <span class="kw">let </span>info = LevelFilter::Info;
|
|
<a href=#1780 id=1780 data-nosnippet>1780</a> <span class="kw">let </span>down = info.decrement_severity();
|
|
<a href=#1781 id=1781 data-nosnippet>1781</a> <span class="macro">assert_eq!</span>(down, LevelFilter::Warn);
|
|
<a href=#1782 id=1782 data-nosnippet>1782</a>
|
|
<a href=#1783 id=1783 data-nosnippet>1783</a> <span class="kw">let </span>error = LevelFilter::Error;
|
|
<a href=#1784 id=1784 data-nosnippet>1784</a> <span class="kw">let </span>down = error.decrement_severity();
|
|
<a href=#1785 id=1785 data-nosnippet>1785</a> <span class="macro">assert_eq!</span>(down, LevelFilter::Off);
|
|
<a href=#1786 id=1786 data-nosnippet>1786</a> <span class="comment">// Off is already the lowest
|
|
<a href=#1787 id=1787 data-nosnippet>1787</a> </span><span class="macro">assert_eq!</span>(down.decrement_severity(), down);
|
|
<a href=#1788 id=1788 data-nosnippet>1788</a> }
|
|
<a href=#1789 id=1789 data-nosnippet>1789</a>
|
|
<a href=#1790 id=1790 data-nosnippet>1790</a> <span class="attr">#[test]
|
|
<a href=#1791 id=1791 data-nosnippet>1791</a> #[cfg_attr(not(debug_assertions), ignore)]
|
|
<a href=#1792 id=1792 data-nosnippet>1792</a> </span><span class="kw">fn </span>test_static_max_level_debug() {
|
|
<a href=#1793 id=1793 data-nosnippet>1793</a> <span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_off"</span>) {
|
|
<a href=#1794 id=1794 data-nosnippet>1794</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Off);
|
|
<a href=#1795 id=1795 data-nosnippet>1795</a> } <span class="kw">else if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_error"</span>) {
|
|
<a href=#1796 id=1796 data-nosnippet>1796</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Error);
|
|
<a href=#1797 id=1797 data-nosnippet>1797</a> } <span class="kw">else if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_warn"</span>) {
|
|
<a href=#1798 id=1798 data-nosnippet>1798</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Warn);
|
|
<a href=#1799 id=1799 data-nosnippet>1799</a> } <span class="kw">else if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_info"</span>) {
|
|
<a href=#1800 id=1800 data-nosnippet>1800</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Info);
|
|
<a href=#1801 id=1801 data-nosnippet>1801</a> } <span class="kw">else if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_debug"</span>) {
|
|
<a href=#1802 id=1802 data-nosnippet>1802</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Debug);
|
|
<a href=#1803 id=1803 data-nosnippet>1803</a> } <span class="kw">else </span>{
|
|
<a href=#1804 id=1804 data-nosnippet>1804</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Trace);
|
|
<a href=#1805 id=1805 data-nosnippet>1805</a> }
|
|
<a href=#1806 id=1806 data-nosnippet>1806</a> }
|
|
<a href=#1807 id=1807 data-nosnippet>1807</a>
|
|
<a href=#1808 id=1808 data-nosnippet>1808</a> <span class="attr">#[test]
|
|
<a href=#1809 id=1809 data-nosnippet>1809</a> #[cfg_attr(debug_assertions, ignore)]
|
|
<a href=#1810 id=1810 data-nosnippet>1810</a> </span><span class="kw">fn </span>test_static_max_level_release() {
|
|
<a href=#1811 id=1811 data-nosnippet>1811</a> <span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">"release_max_level_off"</span>) {
|
|
<a href=#1812 id=1812 data-nosnippet>1812</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Off);
|
|
<a href=#1813 id=1813 data-nosnippet>1813</a> } <span class="kw">else if </span><span class="macro">cfg!</span>(feature = <span class="string">"release_max_level_error"</span>) {
|
|
<a href=#1814 id=1814 data-nosnippet>1814</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Error);
|
|
<a href=#1815 id=1815 data-nosnippet>1815</a> } <span class="kw">else if </span><span class="macro">cfg!</span>(feature = <span class="string">"release_max_level_warn"</span>) {
|
|
<a href=#1816 id=1816 data-nosnippet>1816</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Warn);
|
|
<a href=#1817 id=1817 data-nosnippet>1817</a> } <span class="kw">else if </span><span class="macro">cfg!</span>(feature = <span class="string">"release_max_level_info"</span>) {
|
|
<a href=#1818 id=1818 data-nosnippet>1818</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Info);
|
|
<a href=#1819 id=1819 data-nosnippet>1819</a> } <span class="kw">else if </span><span class="macro">cfg!</span>(feature = <span class="string">"release_max_level_debug"</span>) {
|
|
<a href=#1820 id=1820 data-nosnippet>1820</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Debug);
|
|
<a href=#1821 id=1821 data-nosnippet>1821</a> } <span class="kw">else if </span><span class="macro">cfg!</span>(feature = <span class="string">"release_max_level_trace"</span>) {
|
|
<a href=#1822 id=1822 data-nosnippet>1822</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Trace);
|
|
<a href=#1823 id=1823 data-nosnippet>1823</a> } <span class="kw">else if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_off"</span>) {
|
|
<a href=#1824 id=1824 data-nosnippet>1824</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Off);
|
|
<a href=#1825 id=1825 data-nosnippet>1825</a> } <span class="kw">else if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_error"</span>) {
|
|
<a href=#1826 id=1826 data-nosnippet>1826</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Error);
|
|
<a href=#1827 id=1827 data-nosnippet>1827</a> } <span class="kw">else if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_warn"</span>) {
|
|
<a href=#1828 id=1828 data-nosnippet>1828</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Warn);
|
|
<a href=#1829 id=1829 data-nosnippet>1829</a> } <span class="kw">else if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_info"</span>) {
|
|
<a href=#1830 id=1830 data-nosnippet>1830</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Info);
|
|
<a href=#1831 id=1831 data-nosnippet>1831</a> } <span class="kw">else if </span><span class="macro">cfg!</span>(feature = <span class="string">"max_level_debug"</span>) {
|
|
<a href=#1832 id=1832 data-nosnippet>1832</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Debug);
|
|
<a href=#1833 id=1833 data-nosnippet>1833</a> } <span class="kw">else </span>{
|
|
<a href=#1834 id=1834 data-nosnippet>1834</a> <span class="macro">assert_eq!</span>(STATIC_MAX_LEVEL, LevelFilter::Trace);
|
|
<a href=#1835 id=1835 data-nosnippet>1835</a> }
|
|
<a href=#1836 id=1836 data-nosnippet>1836</a> }
|
|
<a href=#1837 id=1837 data-nosnippet>1837</a>
|
|
<a href=#1838 id=1838 data-nosnippet>1838</a> <span class="attr">#[test]
|
|
<a href=#1839 id=1839 data-nosnippet>1839</a> #[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#1840 id=1840 data-nosnippet>1840</a> </span><span class="kw">fn </span>test_error_trait() {
|
|
<a href=#1841 id=1841 data-nosnippet>1841</a> <span class="kw">use </span><span class="kw">super</span>::SetLoggerError;
|
|
<a href=#1842 id=1842 data-nosnippet>1842</a> <span class="kw">let </span>e = SetLoggerError(());
|
|
<a href=#1843 id=1843 data-nosnippet>1843</a> <span class="macro">assert_eq!</span>(
|
|
<a href=#1844 id=1844 data-nosnippet>1844</a> <span class="kw-2">&</span>e.to_string(),
|
|
<a href=#1845 id=1845 data-nosnippet>1845</a> <span class="string">"attempted to set a logger after the logging system \
|
|
<a href=#1846 id=1846 data-nosnippet>1846</a> was already initialized"
|
|
<a href=#1847 id=1847 data-nosnippet>1847</a> </span>);
|
|
<a href=#1848 id=1848 data-nosnippet>1848</a> }
|
|
<a href=#1849 id=1849 data-nosnippet>1849</a>
|
|
<a href=#1850 id=1850 data-nosnippet>1850</a> <span class="attr">#[test]
|
|
<a href=#1851 id=1851 data-nosnippet>1851</a> </span><span class="kw">fn </span>test_metadata_builder() {
|
|
<a href=#1852 id=1852 data-nosnippet>1852</a> <span class="kw">use </span><span class="kw">super</span>::MetadataBuilder;
|
|
<a href=#1853 id=1853 data-nosnippet>1853</a> <span class="kw">let </span>target = <span class="string">"myApp"</span>;
|
|
<a href=#1854 id=1854 data-nosnippet>1854</a> <span class="kw">let </span>metadata_test = MetadataBuilder::new()
|
|
<a href=#1855 id=1855 data-nosnippet>1855</a> .level(Level::Debug)
|
|
<a href=#1856 id=1856 data-nosnippet>1856</a> .target(target)
|
|
<a href=#1857 id=1857 data-nosnippet>1857</a> .build();
|
|
<a href=#1858 id=1858 data-nosnippet>1858</a> <span class="macro">assert_eq!</span>(metadata_test.level(), Level::Debug);
|
|
<a href=#1859 id=1859 data-nosnippet>1859</a> <span class="macro">assert_eq!</span>(metadata_test.target(), <span class="string">"myApp"</span>);
|
|
<a href=#1860 id=1860 data-nosnippet>1860</a> }
|
|
<a href=#1861 id=1861 data-nosnippet>1861</a>
|
|
<a href=#1862 id=1862 data-nosnippet>1862</a> <span class="attr">#[test]
|
|
<a href=#1863 id=1863 data-nosnippet>1863</a> </span><span class="kw">fn </span>test_metadata_convenience_builder() {
|
|
<a href=#1864 id=1864 data-nosnippet>1864</a> <span class="kw">use </span><span class="kw">super</span>::Metadata;
|
|
<a href=#1865 id=1865 data-nosnippet>1865</a> <span class="kw">let </span>target = <span class="string">"myApp"</span>;
|
|
<a href=#1866 id=1866 data-nosnippet>1866</a> <span class="kw">let </span>metadata_test = Metadata::builder()
|
|
<a href=#1867 id=1867 data-nosnippet>1867</a> .level(Level::Debug)
|
|
<a href=#1868 id=1868 data-nosnippet>1868</a> .target(target)
|
|
<a href=#1869 id=1869 data-nosnippet>1869</a> .build();
|
|
<a href=#1870 id=1870 data-nosnippet>1870</a> <span class="macro">assert_eq!</span>(metadata_test.level(), Level::Debug);
|
|
<a href=#1871 id=1871 data-nosnippet>1871</a> <span class="macro">assert_eq!</span>(metadata_test.target(), <span class="string">"myApp"</span>);
|
|
<a href=#1872 id=1872 data-nosnippet>1872</a> }
|
|
<a href=#1873 id=1873 data-nosnippet>1873</a>
|
|
<a href=#1874 id=1874 data-nosnippet>1874</a> <span class="attr">#[test]
|
|
<a href=#1875 id=1875 data-nosnippet>1875</a> </span><span class="kw">fn </span>test_record_builder() {
|
|
<a href=#1876 id=1876 data-nosnippet>1876</a> <span class="kw">use super</span>::{MetadataBuilder, RecordBuilder};
|
|
<a href=#1877 id=1877 data-nosnippet>1877</a> <span class="kw">let </span>target = <span class="string">"myApp"</span>;
|
|
<a href=#1878 id=1878 data-nosnippet>1878</a> <span class="kw">let </span>metadata = MetadataBuilder::new().target(target).build();
|
|
<a href=#1879 id=1879 data-nosnippet>1879</a> <span class="kw">let </span>fmt_args = <span class="macro">format_args!</span>(<span class="string">"hello"</span>);
|
|
<a href=#1880 id=1880 data-nosnippet>1880</a> <span class="kw">let </span>record_test = RecordBuilder::new()
|
|
<a href=#1881 id=1881 data-nosnippet>1881</a> .args(fmt_args)
|
|
<a href=#1882 id=1882 data-nosnippet>1882</a> .metadata(metadata)
|
|
<a href=#1883 id=1883 data-nosnippet>1883</a> .module_path(<span class="prelude-val">Some</span>(<span class="string">"foo"</span>))
|
|
<a href=#1884 id=1884 data-nosnippet>1884</a> .file(<span class="prelude-val">Some</span>(<span class="string">"bar"</span>))
|
|
<a href=#1885 id=1885 data-nosnippet>1885</a> .line(<span class="prelude-val">Some</span>(<span class="number">30</span>))
|
|
<a href=#1886 id=1886 data-nosnippet>1886</a> .build();
|
|
<a href=#1887 id=1887 data-nosnippet>1887</a> <span class="macro">assert_eq!</span>(record_test.metadata().target(), <span class="string">"myApp"</span>);
|
|
<a href=#1888 id=1888 data-nosnippet>1888</a> <span class="macro">assert_eq!</span>(record_test.module_path(), <span class="prelude-val">Some</span>(<span class="string">"foo"</span>));
|
|
<a href=#1889 id=1889 data-nosnippet>1889</a> <span class="macro">assert_eq!</span>(record_test.file(), <span class="prelude-val">Some</span>(<span class="string">"bar"</span>));
|
|
<a href=#1890 id=1890 data-nosnippet>1890</a> <span class="macro">assert_eq!</span>(record_test.line(), <span class="prelude-val">Some</span>(<span class="number">30</span>));
|
|
<a href=#1891 id=1891 data-nosnippet>1891</a> }
|
|
<a href=#1892 id=1892 data-nosnippet>1892</a>
|
|
<a href=#1893 id=1893 data-nosnippet>1893</a> <span class="attr">#[test]
|
|
<a href=#1894 id=1894 data-nosnippet>1894</a> </span><span class="kw">fn </span>test_record_convenience_builder() {
|
|
<a href=#1895 id=1895 data-nosnippet>1895</a> <span class="kw">use super</span>::{Metadata, Record};
|
|
<a href=#1896 id=1896 data-nosnippet>1896</a> <span class="kw">let </span>target = <span class="string">"myApp"</span>;
|
|
<a href=#1897 id=1897 data-nosnippet>1897</a> <span class="kw">let </span>metadata = Metadata::builder().target(target).build();
|
|
<a href=#1898 id=1898 data-nosnippet>1898</a> <span class="kw">let </span>fmt_args = <span class="macro">format_args!</span>(<span class="string">"hello"</span>);
|
|
<a href=#1899 id=1899 data-nosnippet>1899</a> <span class="kw">let </span>record_test = Record::builder()
|
|
<a href=#1900 id=1900 data-nosnippet>1900</a> .args(fmt_args)
|
|
<a href=#1901 id=1901 data-nosnippet>1901</a> .metadata(metadata)
|
|
<a href=#1902 id=1902 data-nosnippet>1902</a> .module_path(<span class="prelude-val">Some</span>(<span class="string">"foo"</span>))
|
|
<a href=#1903 id=1903 data-nosnippet>1903</a> .file(<span class="prelude-val">Some</span>(<span class="string">"bar"</span>))
|
|
<a href=#1904 id=1904 data-nosnippet>1904</a> .line(<span class="prelude-val">Some</span>(<span class="number">30</span>))
|
|
<a href=#1905 id=1905 data-nosnippet>1905</a> .build();
|
|
<a href=#1906 id=1906 data-nosnippet>1906</a> <span class="macro">assert_eq!</span>(record_test.target(), <span class="string">"myApp"</span>);
|
|
<a href=#1907 id=1907 data-nosnippet>1907</a> <span class="macro">assert_eq!</span>(record_test.module_path(), <span class="prelude-val">Some</span>(<span class="string">"foo"</span>));
|
|
<a href=#1908 id=1908 data-nosnippet>1908</a> <span class="macro">assert_eq!</span>(record_test.file(), <span class="prelude-val">Some</span>(<span class="string">"bar"</span>));
|
|
<a href=#1909 id=1909 data-nosnippet>1909</a> <span class="macro">assert_eq!</span>(record_test.line(), <span class="prelude-val">Some</span>(<span class="number">30</span>));
|
|
<a href=#1910 id=1910 data-nosnippet>1910</a> }
|
|
<a href=#1911 id=1911 data-nosnippet>1911</a>
|
|
<a href=#1912 id=1912 data-nosnippet>1912</a> <span class="attr">#[test]
|
|
<a href=#1913 id=1913 data-nosnippet>1913</a> </span><span class="kw">fn </span>test_record_complete_builder() {
|
|
<a href=#1914 id=1914 data-nosnippet>1914</a> <span class="kw">use super</span>::{Level, Record};
|
|
<a href=#1915 id=1915 data-nosnippet>1915</a> <span class="kw">let </span>target = <span class="string">"myApp"</span>;
|
|
<a href=#1916 id=1916 data-nosnippet>1916</a> <span class="kw">let </span>record_test = Record::builder()
|
|
<a href=#1917 id=1917 data-nosnippet>1917</a> .module_path(<span class="prelude-val">Some</span>(<span class="string">"foo"</span>))
|
|
<a href=#1918 id=1918 data-nosnippet>1918</a> .file(<span class="prelude-val">Some</span>(<span class="string">"bar"</span>))
|
|
<a href=#1919 id=1919 data-nosnippet>1919</a> .line(<span class="prelude-val">Some</span>(<span class="number">30</span>))
|
|
<a href=#1920 id=1920 data-nosnippet>1920</a> .target(target)
|
|
<a href=#1921 id=1921 data-nosnippet>1921</a> .level(Level::Error)
|
|
<a href=#1922 id=1922 data-nosnippet>1922</a> .build();
|
|
<a href=#1923 id=1923 data-nosnippet>1923</a> <span class="macro">assert_eq!</span>(record_test.target(), <span class="string">"myApp"</span>);
|
|
<a href=#1924 id=1924 data-nosnippet>1924</a> <span class="macro">assert_eq!</span>(record_test.level(), Level::Error);
|
|
<a href=#1925 id=1925 data-nosnippet>1925</a> <span class="macro">assert_eq!</span>(record_test.module_path(), <span class="prelude-val">Some</span>(<span class="string">"foo"</span>));
|
|
<a href=#1926 id=1926 data-nosnippet>1926</a> <span class="macro">assert_eq!</span>(record_test.file(), <span class="prelude-val">Some</span>(<span class="string">"bar"</span>));
|
|
<a href=#1927 id=1927 data-nosnippet>1927</a> <span class="macro">assert_eq!</span>(record_test.line(), <span class="prelude-val">Some</span>(<span class="number">30</span>));
|
|
<a href=#1928 id=1928 data-nosnippet>1928</a> }
|
|
<a href=#1929 id=1929 data-nosnippet>1929</a>
|
|
<a href=#1930 id=1930 data-nosnippet>1930</a> <span class="attr">#[test]
|
|
<a href=#1931 id=1931 data-nosnippet>1931</a> #[cfg(feature = <span class="string">"kv"</span>)]
|
|
<a href=#1932 id=1932 data-nosnippet>1932</a> </span><span class="kw">fn </span>test_record_key_values_builder() {
|
|
<a href=#1933 id=1933 data-nosnippet>1933</a> <span class="kw">use </span><span class="kw">super</span>::Record;
|
|
<a href=#1934 id=1934 data-nosnippet>1934</a> <span class="kw">use </span><span class="kw">crate</span>::kv::{<span class="self">self</span>, VisitSource};
|
|
<a href=#1935 id=1935 data-nosnippet>1935</a>
|
|
<a href=#1936 id=1936 data-nosnippet>1936</a> <span class="kw">struct </span>TestVisitSource {
|
|
<a href=#1937 id=1937 data-nosnippet>1937</a> seen_pairs: usize,
|
|
<a href=#1938 id=1938 data-nosnippet>1938</a> }
|
|
<a href=#1939 id=1939 data-nosnippet>1939</a>
|
|
<a href=#1940 id=1940 data-nosnippet>1940</a> <span class="kw">impl</span><<span class="lifetime">'kvs</span>> VisitSource<<span class="lifetime">'kvs</span>> <span class="kw">for </span>TestVisitSource {
|
|
<a href=#1941 id=1941 data-nosnippet>1941</a> <span class="kw">fn </span>visit_pair(
|
|
<a href=#1942 id=1942 data-nosnippet>1942</a> <span class="kw-2">&mut </span><span class="self">self</span>,
|
|
<a href=#1943 id=1943 data-nosnippet>1943</a> <span class="kw">_</span>: kv::Key<<span class="lifetime">'kvs</span>>,
|
|
<a href=#1944 id=1944 data-nosnippet>1944</a> <span class="kw">_</span>: kv::Value<<span class="lifetime">'kvs</span>>,
|
|
<a href=#1945 id=1945 data-nosnippet>1945</a> ) -> <span class="prelude-ty">Result</span><(), kv::Error> {
|
|
<a href=#1946 id=1946 data-nosnippet>1946</a> <span class="self">self</span>.seen_pairs += <span class="number">1</span>;
|
|
<a href=#1947 id=1947 data-nosnippet>1947</a> <span class="prelude-val">Ok</span>(())
|
|
<a href=#1948 id=1948 data-nosnippet>1948</a> }
|
|
<a href=#1949 id=1949 data-nosnippet>1949</a> }
|
|
<a href=#1950 id=1950 data-nosnippet>1950</a>
|
|
<a href=#1951 id=1951 data-nosnippet>1951</a> <span class="kw">let </span>kvs: <span class="kw-2">&</span>[(<span class="kw-2">&</span>str, i32)] = <span class="kw-2">&</span>[(<span class="string">"a"</span>, <span class="number">1</span>), (<span class="string">"b"</span>, <span class="number">2</span>)];
|
|
<a href=#1952 id=1952 data-nosnippet>1952</a> <span class="kw">let </span>record_test = Record::builder().key_values(<span class="kw-2">&</span>kvs).build();
|
|
<a href=#1953 id=1953 data-nosnippet>1953</a>
|
|
<a href=#1954 id=1954 data-nosnippet>1954</a> <span class="kw">let </span><span class="kw-2">mut </span>visitor = TestVisitSource { seen_pairs: <span class="number">0 </span>};
|
|
<a href=#1955 id=1955 data-nosnippet>1955</a>
|
|
<a href=#1956 id=1956 data-nosnippet>1956</a> record_test.key_values().visit(<span class="kw-2">&mut </span>visitor).unwrap();
|
|
<a href=#1957 id=1957 data-nosnippet>1957</a>
|
|
<a href=#1958 id=1958 data-nosnippet>1958</a> <span class="macro">assert_eq!</span>(<span class="number">2</span>, visitor.seen_pairs);
|
|
<a href=#1959 id=1959 data-nosnippet>1959</a> }
|
|
<a href=#1960 id=1960 data-nosnippet>1960</a>
|
|
<a href=#1961 id=1961 data-nosnippet>1961</a> <span class="attr">#[test]
|
|
<a href=#1962 id=1962 data-nosnippet>1962</a> #[cfg(feature = <span class="string">"kv"</span>)]
|
|
<a href=#1963 id=1963 data-nosnippet>1963</a> </span><span class="kw">fn </span>test_record_key_values_get_coerce() {
|
|
<a href=#1964 id=1964 data-nosnippet>1964</a> <span class="kw">use </span><span class="kw">super</span>::Record;
|
|
<a href=#1965 id=1965 data-nosnippet>1965</a>
|
|
<a href=#1966 id=1966 data-nosnippet>1966</a> <span class="kw">let </span>kvs: <span class="kw-2">&</span>[(<span class="kw-2">&</span>str, <span class="kw-2">&</span>str)] = <span class="kw-2">&</span>[(<span class="string">"a"</span>, <span class="string">"1"</span>), (<span class="string">"b"</span>, <span class="string">"2"</span>)];
|
|
<a href=#1967 id=1967 data-nosnippet>1967</a> <span class="kw">let </span>record = Record::builder().key_values(<span class="kw-2">&</span>kvs).build();
|
|
<a href=#1968 id=1968 data-nosnippet>1968</a>
|
|
<a href=#1969 id=1969 data-nosnippet>1969</a> <span class="macro">assert_eq!</span>(
|
|
<a href=#1970 id=1970 data-nosnippet>1970</a> <span class="string">"2"</span>,
|
|
<a href=#1971 id=1971 data-nosnippet>1971</a> record
|
|
<a href=#1972 id=1972 data-nosnippet>1972</a> .key_values()
|
|
<a href=#1973 id=1973 data-nosnippet>1973</a> .get(<span class="string">"b"</span>.into())
|
|
<a href=#1974 id=1974 data-nosnippet>1974</a> .expect(<span class="string">"missing key"</span>)
|
|
<a href=#1975 id=1975 data-nosnippet>1975</a> .to_borrowed_str()
|
|
<a href=#1976 id=1976 data-nosnippet>1976</a> .expect(<span class="string">"invalid value"</span>)
|
|
<a href=#1977 id=1977 data-nosnippet>1977</a> );
|
|
<a href=#1978 id=1978 data-nosnippet>1978</a> }
|
|
<a href=#1979 id=1979 data-nosnippet>1979</a>
|
|
<a href=#1980 id=1980 data-nosnippet>1980</a> <span class="comment">// Test that the `impl Log for Foo` blocks work
|
|
<a href=#1981 id=1981 data-nosnippet>1981</a> // This test mostly operates on a type level, so failures will be compile errors
|
|
<a href=#1982 id=1982 data-nosnippet>1982</a> </span><span class="attr">#[test]
|
|
<a href=#1983 id=1983 data-nosnippet>1983</a> </span><span class="kw">fn </span>test_foreign_impl() {
|
|
<a href=#1984 id=1984 data-nosnippet>1984</a> <span class="kw">use </span><span class="kw">super</span>::Log;
|
|
<a href=#1985 id=1985 data-nosnippet>1985</a> <span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#1986 id=1986 data-nosnippet>1986</a> </span><span class="kw">use </span>std::sync::Arc;
|
|
<a href=#1987 id=1987 data-nosnippet>1987</a>
|
|
<a href=#1988 id=1988 data-nosnippet>1988</a> <span class="kw">fn </span>assert_is_log<T: Log + <span class="question-mark">?</span>Sized>() {}
|
|
<a href=#1989 id=1989 data-nosnippet>1989</a>
|
|
<a href=#1990 id=1990 data-nosnippet>1990</a> assert_is_log::<<span class="kw-2">&</span><span class="kw">dyn </span>Log>();
|
|
<a href=#1991 id=1991 data-nosnippet>1991</a>
|
|
<a href=#1992 id=1992 data-nosnippet>1992</a> <span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#1993 id=1993 data-nosnippet>1993</a> </span>assert_is_log::<Box<<span class="kw">dyn </span>Log>>();
|
|
<a href=#1994 id=1994 data-nosnippet>1994</a>
|
|
<a href=#1995 id=1995 data-nosnippet>1995</a> <span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#1996 id=1996 data-nosnippet>1996</a> </span>assert_is_log::<Arc<<span class="kw">dyn </span>Log>>();
|
|
<a href=#1997 id=1997 data-nosnippet>1997</a>
|
|
<a href=#1998 id=1998 data-nosnippet>1998</a> <span class="comment">// Assert these statements for all T: Log + ?Sized
|
|
<a href=#1999 id=1999 data-nosnippet>1999</a> </span><span class="attr">#[allow(unused)]
|
|
<a href=#2000 id=2000 data-nosnippet>2000</a> </span><span class="kw">fn </span>forall<T: Log + <span class="question-mark">?</span>Sized>() {
|
|
<a href=#2001 id=2001 data-nosnippet>2001</a> <span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#2002 id=2002 data-nosnippet>2002</a> </span>assert_is_log::<Box<T>>();
|
|
<a href=#2003 id=2003 data-nosnippet>2003</a>
|
|
<a href=#2004 id=2004 data-nosnippet>2004</a> assert_is_log::<<span class="kw-2">&</span>T>();
|
|
<a href=#2005 id=2005 data-nosnippet>2005</a>
|
|
<a href=#2006 id=2006 data-nosnippet>2006</a> <span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#2007 id=2007 data-nosnippet>2007</a> </span>assert_is_log::<Arc<T>>();
|
|
<a href=#2008 id=2008 data-nosnippet>2008</a> }
|
|
<a href=#2009 id=2009 data-nosnippet>2009</a> }
|
|
<a href=#2010 id=2010 data-nosnippet>2010</a>}
|
|
</code></pre></div></section></main></body></html> |