41 lines
11 KiB
HTML
41 lines
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="Formatting (and parsing) utilities for date and time."><meta name="keywords" content="rust, rustlang, rust-lang, format"><title>chrono::format - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[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="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../../chrono/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Module format</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><div id="sidebar-vars" data-name="format" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../chrono/index.html"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">chrono</a>::<wbr><a class="mod" href="#">format</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></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/chrono/format/mod.rs.html#4-938" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Formatting (and parsing) utilities for date and time.</p>
|
||
<p>This module provides the common types and routines to implement,
|
||
for example, <a href="../struct.DateTime.html#method.format"><code>DateTime::format</code></a> or
|
||
<a href="../struct.DateTime.html#method.parse_from_str"><code>DateTime::parse_from_str</code></a> methods.
|
||
For most cases you should use these high-level interfaces.</p>
|
||
<p>Internally the formatting and parsing shares the same abstract <strong>formatting items</strong>,
|
||
which are just an <a href="https://doc.rust-lang.org/std/iter/trait.Iterator.html"><code>Iterator</code></a> of
|
||
the <a href="./enum.Item.html"><code>Item</code></a> type.
|
||
They are generated from more readable <strong>format strings</strong>;
|
||
currently Chrono supports <a href="./strftime/index.html">one built-in syntax closely resembling
|
||
C’s <code>strftime</code> format</a>.</p>
|
||
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left import-item"><code>pub use self::strftime::<a class="struct" href="strftime/struct.StrftimeItems.html" title="struct chrono::format::strftime::StrftimeItems">StrftimeItems</a>;</code></div><div class="item-right docblock-short"></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="strftime/index.html" title="chrono::format::strftime mod">strftime</a></div><div class="item-right docblock-short"><p><code>strftime</code>/<code>strptime</code>-inspired date and time formatting syntax.</p>
|
||
</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DelayedFormat.html" title="chrono::format::DelayedFormat struct">DelayedFormat</a></div><div class="item-right docblock-short"><p>A <em>temporary</em> object which can be used as an argument to <code>format!</code> or others.
|
||
This is normally constructed via <code>format</code> methods of each date and time type.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.InternalFixed.html" title="chrono::format::InternalFixed struct">InternalFixed</a></div><div class="item-right docblock-short"><p>An opaque type representing fixed-format item types for internal uses only.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.InternalNumeric.html" title="chrono::format::InternalNumeric struct">InternalNumeric</a></div><div class="item-right docblock-short"><p>An opaque type representing numeric item types for internal uses only.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ParseError.html" title="chrono::format::ParseError struct">ParseError</a></div><div class="item-right docblock-short"><p>An error from the <code>parse</code> function.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Parsed.html" title="chrono::format::Parsed struct">Parsed</a></div><div class="item-right docblock-short"><p>Parsed parts of date and time. There are two classes of methods:</p>
|
||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Fixed.html" title="chrono::format::Fixed enum">Fixed</a></div><div class="item-right docblock-short"><p>Fixed-format item types.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Item.html" title="chrono::format::Item enum">Item</a></div><div class="item-right docblock-short"><p>A single formatting item. This is used for both formatting and parsing.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Numeric.html" title="chrono::format::Numeric enum">Numeric</a></div><div class="item-right docblock-short"><p>Numeric item types.
|
||
They have associated formatting width (FW) and parsing width (PW).</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Pad.html" title="chrono::format::Pad enum">Pad</a></div><div class="item-right docblock-short"><p>Padding characters for numeric items.</p>
|
||
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.format.html" title="chrono::format::format fn">format</a></div><div class="item-right docblock-short"><p>Tries to format given arguments with given formatting items.
|
||
Internally used by <code>DelayedFormat</code>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.format_item.html" title="chrono::format::format_item fn">format_item</a></div><div class="item-right docblock-short"><p>Formats single formatting item</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.parse.html" title="chrono::format::parse fn">parse</a></div><div class="item-right docblock-short"><p>Tries to parse given string into <code>parsed</code> with given formatting items.
|
||
Returns <code>Ok</code> when the entire string has been parsed (otherwise <code>parsed</code> should not be used).
|
||
There should be no trailing string after parsing;
|
||
use a stray <a href="./enum.Item.html#variant.Space"><code>Item::Space</code></a> to trim whitespaces.</p>
|
||
</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.ParseResult.html" title="chrono::format::ParseResult type">ParseResult</a></div><div class="item-right docblock-short"><p>Same as <code>Result<T, ParseError></code>.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="chrono" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |