<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Doing::Logger
— Documentation by YARD 0.9.28
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Doing::Logger";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (L)</a> »
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
»
<span class="title">Logger</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Doing::Logger
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></span>
<ul class="fullTree">
<li><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></li>
<li class="next">Doing::Logger</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/logger.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Log adapter</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="TOPIC_WIDTH-constant" class="">TOPIC_WIDTH =
</dt>
<dd><pre class="code"><span class='int'>12</span></pre></dd>
<dt id="LOG_LEVELS-constant" class="">LOG_LEVELS =
</dt>
<dd><pre class="code"><span class='lbrace'>{</span>
<span class='label'>debug:</span> <span class='op'>::</span><span class='const'>Logger</span><span class='op'>::</span><span class='const'>DEBUG</span><span class='comma'>,</span>
<span class='label'>info:</span> <span class='op'>::</span><span class='const'>Logger</span><span class='op'>::</span><span class='const'>INFO</span><span class='comma'>,</span>
<span class='label'>warn:</span> <span class='op'>::</span><span class='const'>Logger</span><span class='op'>::</span><span class='const'>WARN</span><span class='comma'>,</span>
<span class='label'>error:</span> <span class='op'>::</span><span class='const'>Logger</span><span class='op'>::</span><span class='const'>ERROR</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="COUNT_KEYS-constant" class="">COUNT_KEYS =
</dt>
<dd><pre class="code"><span class='qsymbols_beg'>%i[</span><span class='words_sep'>
</span><span class='tstring_content'>added</span><span class='words_sep'>
</span><span class='tstring_content'>added_tags</span><span class='words_sep'>
</span><span class='tstring_content'>archived</span><span class='words_sep'>
</span><span class='tstring_content'>autotag</span><span class='words_sep'>
</span><span class='tstring_content'>completed</span><span class='words_sep'>
</span><span class='tstring_content'>completed_archived</span><span class='words_sep'>
</span><span class='tstring_content'>deleted</span><span class='words_sep'>
</span><span class='tstring_content'>moved</span><span class='words_sep'>
</span><span class='tstring_content'>removed_tags</span><span class='words_sep'>
</span><span class='tstring_content'>rotated</span><span class='words_sep'>
</span><span class='tstring_content'>skipped</span><span class='words_sep'>
</span><span class='tstring_content'>updated</span><span class='words_sep'>
</span><span class='tstring_content'>exported</span><span class='words_sep'>
</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
</dl>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#level-instance_method" title="#level (instance method)">#<strong>level</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the current log level (debug, info, warn, error).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#logdev=-instance_method" title="#logdev= (instance method)">#<strong>logdev</strong> ⇒ Object </a>
</span>
<span class="note title writeonly">writeonly</span>
<span class="summary_desc"><div class='inline'><p>Sets the log device.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#max_length=-instance_method" title="#max_length= (instance method)">#<strong>max_length</strong> ⇒ Object </a>
</span>
<span class="note title writeonly">writeonly</span>
<span class="summary_desc"><div class='inline'><p>Max length of log messages (truncate in middle).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#messages-instance_method" title="#messages (instance method)">#<strong>messages</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute messages.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#results-instance_method" title="#results (instance method)">#<strong>results</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute results.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#abort_with-instance_method" title="#abort_with (instance method)">#<strong>abort_with</strong>(topic, message = nil, &block) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Print an error message and immediately abort the process.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#adjust_verbosity-instance_method" title="#adjust_verbosity (instance method)">#<strong>adjust_verbosity</strong>(options = {}) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#benchmark-instance_method" title="#benchmark (instance method)">#<strong>benchmark</strong>(key, state) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#count-instance_method" title="#count (instance method)">#<strong>count</strong>(key, level: :info, count: 1, tag: nil, message: nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#debug-instance_method" title="#debug (instance method)">#<strong>debug</strong>(topic, message = nil, &block) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Print a debug message.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#error-instance_method" title="#error (instance method)">#<strong>error</strong>(topic, message = nil, &block) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Print an error message.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#formatted_topic-instance_method" title="#formatted_topic (instance method)">#<strong>formatted_topic</strong>(topic, colon: false) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Format the topic.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#info-instance_method" title="#info (instance method)">#<strong>info</strong>(topic, message = nil, &block) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Print a message.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(level = :info) ⇒ Logger </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Create a new instance of a log writer.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log_benchmarks-instance_method" title="#log_benchmarks (instance method)">#<strong>log_benchmarks</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log_change-instance_method" title="#log_change (instance method)">#<strong>log_change</strong>(tags_added: [], tags_removed: [], count: 1, item: nil, single: false) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log_level=-instance_method" title="#log_level= (instance method)">#<strong>log_level=</strong>(level = 'info') ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Set the log level on the writer.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#log_now-instance_method" title="#log_now (instance method)">#<strong>log_now</strong>(level, topic, message = nil, &block) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Log to console immediately instead of writing messages on exit.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#output_results-instance_method" title="#output_results (instance method)">#<strong>output_results</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Output registers based on log level.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#restore_level-instance_method" title="#restore_level (instance method)">#<strong>restore_level</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Restore temporary level.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#temp_level-instance_method" title="#temp_level (instance method)">#<strong>temp_level</strong>(level) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Set log level temporarily.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#warn-instance_method" title="#warn (instance method)">#<strong>warn</strong>(topic, message = nil, &block) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Print a message.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#write-instance_method" title="#write (instance method)">#<strong>write</strong>(level_of_message, topic, message = nil, &block) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Log a message.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(level = :info) ⇒ <tt><span class='object_link'><a href="" title="Doing::Logger (class)">Logger</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new instance of a log writer</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>level</span>
<span class='type'>(<tt>optional</tt>, <tt>symbol</tt>)</span>
<em class="default">(defaults to: <tt>:info</tt>)</em>
—
<div class='inline'><p>the log level</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="level-instance_method">
#<strong>level</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the current log level (debug, info, warn, error)</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="logdev=-instance_method">
#<strong>logdev=</strong>(value) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(writeonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Sets the log device</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="max_length=-instance_method">
#<strong>max_length=</strong>(value) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(writeonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Max length of log messages (truncate in middle)</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="messages-instance_method">
#<strong>messages</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute messages.</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="results-instance_method">
#<strong>results</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute results.</p>
</div>
</div>
<div class="tags">
</div>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="abort_with-instance_method">
#<strong>abort_with</strong>(topic, message = nil, &block) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Print an error message and immediately
abort the process</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>topic</span>
<span class='type'></span>
—
<div class='inline'><p>the topic of the message, e.g.
"Configuration file",
"Deprecation", etc.</p>
</div>
</li>
<li>
<span class='name'>message</span>
<span class='type'></span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>the message detail (can be
omitted)</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>nothing</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="adjust_verbosity-instance_method">
#<strong>adjust_verbosity</strong>(options = {}) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="benchmark-instance_method">
#<strong>benchmark</strong>(key, state) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="count-instance_method">
#<strong>count</strong>(key, level: :info, count: 1, tag: nil, message: nil) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>ArgumentError</tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="debug-instance_method">
#<strong>debug</strong>(topic, message = nil, &block) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Print a debug message</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>topic</span>
<span class='type'></span>
—
<div class='inline'><p>the topic of the message</p>
</div>
</li>
<li>
<span class='name'>message</span>
<span class='type'></span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>the message detail</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>nothing</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="error-instance_method">
#<strong>error</strong>(topic, message = nil, &block) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Print an error message</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>topic</span>
<span class='type'></span>
—
<div class='inline'><p>the topic of the message, e.g.
"Configuration file",
"Deprecation", etc.</p>
</div>
</li>
<li>
<span class='name'>message</span>
<span class='type'></span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>the message detail</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>nothing</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="formatted_topic-instance_method">
#<strong>formatted_topic</strong>(topic, colon: false) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Format the topic</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>topic</span>
<span class='type'></span>
—
<div class='inline'><p>the topic of the message, e.g.
"Configuration file",
"Deprecation", etc.</p>
</div>
</li>
<li>
<span class='name'>colon</span>
<span class='type'></span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>Separate with a colon?</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>the formatted topic statement</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="info-instance_method">
#<strong>info</strong>(topic, message = nil, &block) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Print a message</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>topic</span>
<span class='type'></span>
—
<div class='inline'><p>the topic of the message, e.g.
"Configuration file",
"Deprecation", etc.</p>
</div>
</li>
<li>
<span class='name'>message</span>
<span class='type'></span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>the message detail</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>nothing</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="log_benchmarks-instance_method">
#<strong>log_benchmarks</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="log_change-instance_method">
#<strong>log_change</strong>(tags_added: [], tags_removed: [], count: 1, item: nil, single: false) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="log_level=-instance_method">
#<strong>log_level=</strong>(level = 'info') ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Set the log level on the writer</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>level</span>
<span class='type'>(<tt>symbol</tt>)</span>
<em class="default">(defaults to: <tt>'info'</tt>)</em>
—
<div class='inline'><p>the log level</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>nothing</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="log_now-instance_method">
#<strong>log_now</strong>(level, topic, message = nil, &block) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Log to console immediately instead of writing messages on exit</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>level</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
—
<div class='inline'><p>The level</p>
</div>
</li>
<li>
<span class='name'>topic</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The topic or full message</p>
</div>
</li>
<li>
<span class='name'>message</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The message (optional)</p>
</div>
</li>
<li>
<span class='name'>block</span>
<span class='type'></span>
—
<div class='inline'><p>a block containing the message (optional)</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="output_results-instance_method">
#<strong>output_results</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Output registers based on log level</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>nothing</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="restore_level-instance_method">
#<strong>restore_level</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Restore temporary level</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="temp_level-instance_method">
#<strong>temp_level</strong>(level) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Set log level temporarily</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="warn-instance_method">
#<strong>warn</strong>(topic, message = nil, &block) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Print a message</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>topic</span>
<span class='type'></span>
—
<div class='inline'><p>the topic of the message, e.g.
"Configuration file",
"Deprecation", etc.</p>
</div>
</li>
<li>
<span class='name'>message</span>
<span class='type'></span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>the message detail</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>nothing</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="write-instance_method">
#<strong>write</strong>(level_of_message, topic, message = nil, &block) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Log a message.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>level_of_message</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
—
<div class='inline'><p>the Symbol
level of message, one of
:debug, :info, :warn,
:error</p>
</div>
</li>
<li>
<span class='name'>topic</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>the String
topic or full message</p>
</div>
</li>
<li>
<span class='name'>message</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>the String
message (optional)</p>
</div>
</li>
<li>
<span class='name'>block</span>
<span class='type'></span>
—
<div class='inline'><p>a block containing the
message (optional)</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>false if the message was not written</p>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Mar 11 06:08:17 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.0.1).
</div>
</div>
</body>
</html>