244 lines
No EOL
11 KiB
HTML
244 lines
No EOL
11 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="API documentation for the Rust `humantime` crate.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, humantime">
|
||
|
||
<title>humantime - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../normalize.css">
|
||
<link rel="stylesheet" type="text/css" href="../rustdoc.css"
|
||
id="mainThemeStyle">
|
||
|
||
<link rel="stylesheet" type="text/css" href="../dark.css">
|
||
<link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle">
|
||
<script src="../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc mod">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
<div class="sidebar-menu">☰</div>
|
||
|
||
<p class='location'>Crate humantime</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'humantime', ty: 'mod', relpath: '../'};</script></div>
|
||
</nav>
|
||
|
||
<div class="theme-picker">
|
||
<button id="theme-picker" aria-label="Pick another theme!">
|
||
<img src="../brush.svg" width="18" alt="Pick another theme!">
|
||
</button>
|
||
<div id="theme-choices"></div>
|
||
</div>
|
||
<script src="../theme.js"></script>
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>humantime</a></span><span class='out-of-band'><span id='render-detail'>
|
||
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
||
[<span class='inner'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../src/humantime/lib.rs.html#1-30' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Human-friendly time parser and formatter</p>
|
||
<p>Features:</p>
|
||
<ul>
|
||
<li>Parses durations in free form like <code>15days 2min 2s</code></li>
|
||
<li>Formats durations in similar form <code>2years 2min 12us</code></li>
|
||
<li>Parses and formats timestamp in <code>rfc3339</code> format: <code>2018-01-01T12:53:00Z</code></li>
|
||
<li>Parses timestamps in a weaker format: <code>2018-01-01 12:53:00</code></li>
|
||
</ul>
|
||
<p>Timestamp parsing/formatting is super-fast because format is basically
|
||
fixed.</p>
|
||
<p>See <a href="https://docs.rs/serde-humantime/0.1.1/serde_humantime/">serde-humantime</a> for serde integration.</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Duration.html"
|
||
title='struct humantime::Duration'>Duration</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A wrapper for duration that has <code>FromStr</code> implementation</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.FormattedDuration.html"
|
||
title='struct humantime::FormattedDuration'>FormattedDuration</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A wrapper type that allows you to Display a Duration</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Rfc3339Timestamp.html"
|
||
title='struct humantime::Rfc3339Timestamp'>Rfc3339Timestamp</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A wrapper type that allows you to Display a SystemTime</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Timestamp.html"
|
||
title='struct humantime::Timestamp'>Timestamp</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A wrapper for SystemTime that has <code>FromStr</code> implementation</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.DurationError.html"
|
||
title='enum humantime::DurationError'>DurationError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Error parsing human-friendly duration</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.TimestampError.html"
|
||
title='enum humantime::TimestampError'>TimestampError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Error parsing datetime (timestamp)</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.format_duration.html"
|
||
title='fn humantime::format_duration'>format_duration</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Formats duration into a human-readable string</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.format_rfc3339.html"
|
||
title='fn humantime::format_rfc3339'>format_rfc3339</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Format an RFC3339 timestamp <code>2018-02-14T00:28:07Z</code></p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.format_rfc3339_nanos.html"
|
||
title='fn humantime::format_rfc3339_nanos'>format_rfc3339_nanos</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Format an RFC3339 timestamp <code>2018-02-14T00:28:07.000000000Z</code></p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.format_rfc3339_seconds.html"
|
||
title='fn humantime::format_rfc3339_seconds'>format_rfc3339_seconds</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Format an RFC3339 timestamp <code>2018-02-14T00:28:07Z</code></p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.parse_duration.html"
|
||
title='fn humantime::parse_duration'>parse_duration</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Parse duration object <code>1hour 12min 5s</code></p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.parse_rfc3339.html"
|
||
title='fn humantime::parse_rfc3339'>parse_rfc3339</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Parse RFC3339 timestamp <code>2018-02-14T00:28:07Z</code></p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.parse_rfc3339_weak.html"
|
||
title='fn humantime::parse_rfc3339_weak'>parse_rfc3339_weak</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Parse RFC3339-like timestamp <code>2018-02-14 00:28:07</code></p>
|
||
|
||
</td>
|
||
</tr></table></section>
|
||
<section id='search' class="content hidden"></section>
|
||
|
||
<section class="footer"></section>
|
||
|
||
<aside id="help" class="hidden">
|
||
<div>
|
||
<h1 class="hidden">Help</h1>
|
||
|
||
<div class="shortcuts">
|
||
<h2>Keyboard Shortcuts</h2>
|
||
|
||
<dl>
|
||
<dt><kbd>?</kbd></dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt><kbd>S</kbd></dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt><kbd>↑</kbd></dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt><kbd>↓</kbd></dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt><kbd>↹</kbd></dt>
|
||
<dd>Switch tab</dd>
|
||
<dt><kbd>⏎</kbd></dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt><kbd>+</kbd></dt>
|
||
<dd>Expand all sections</dd>
|
||
<dt><kbd>-</kbd></dt>
|
||
<dd>Collapse all sections</dd>
|
||
</dl>
|
||
</div>
|
||
|
||
<div class="infos">
|
||
<h2>Search Tricks</h2>
|
||
|
||
<p>
|
||
Prefix searches with a type followed by a colon (e.g.
|
||
<code>fn:</code>) to restrict the search to a given type.
|
||
</p>
|
||
|
||
<p>
|
||
Accepted types are: <code>fn</code>, <code>mod</code>,
|
||
<code>struct</code>, <code>enum</code>,
|
||
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
||
and <code>const</code>.
|
||
</p>
|
||
|
||
<p>
|
||
Search functions by type signature (e.g.
|
||
<code>vec -> usize</code> or <code>* -> vec</code>)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../";
|
||
window.currentCrate = "humantime";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |