OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
c845eb3e1f76e51dbe2d22f3712ac4520d181f7d
google-apis-rs/chrono/format/index.html
Sebastian Thiel 37ba635de2 Update documentation
2021-04-02 00:20:57 +08:00

42 lines
8.8 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `format` mod in crate `chrono`."><meta name="keywords" content="rust, rustlang, rust-lang, format"><title>chrono::format - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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">&#9776;</div><a href='../../chrono/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module format</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><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><p class="location"><a href="../index.html">chrono</a></p><div id="sidebar-vars" data-name="format" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><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" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">chrono</a>::<wbr><a class="mod" href="">format</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">&#x2212;</span>]</a></span><a class="srclink" href="../../src/chrono/format/mod.rs.html#4-938" title="goto source code">[src]</a></span></h1><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><h2 id="reexports" class="section-header"><a href="#reexports">Re-exports</a></h2>
<table><tr><td><code>pub use self::strftime::<a class="struct" href="../../chrono/format/strftime/struct.StrftimeItems.html" title="struct chrono::format::strftime::StrftimeItems">StrftimeItems</a>;</code></td></tr></table><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2>
<table><tr class="module-item"><td><a class="mod" href="strftime/index.html" title="chrono::format::strftime mod">strftime</a></td><td class="docblock-short"><p><code>strftime</code>/<code>strptime</code>-inspired date and time formatting syntax.</p>
</td></tr></table><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.DelayedFormat.html" title="chrono::format::DelayedFormat struct">DelayedFormat</a></td><td class="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>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.InternalFixed.html" title="chrono::format::InternalFixed struct">InternalFixed</a></td><td class="docblock-short"><p>An opaque type representing fixed-format item types for internal uses only.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.InternalNumeric.html" title="chrono::format::InternalNumeric struct">InternalNumeric</a></td><td class="docblock-short"><p>An opaque type representing numeric item types for internal uses only.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ParseError.html" title="chrono::format::ParseError struct">ParseError</a></td><td class="docblock-short"><p>An error from the <code>parse</code> function.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Parsed.html" title="chrono::format::Parsed struct">Parsed</a></td><td class="docblock-short"><p>Parsed parts of date and time. There are two classes of methods:</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.Fixed.html" title="chrono::format::Fixed enum">Fixed</a></td><td class="docblock-short"><p>Fixed-format item types.</p>
</td></tr><tr class="module-item"><td><a class="enum" href="enum.Item.html" title="chrono::format::Item enum">Item</a></td><td class="docblock-short"><p>A single formatting item. This is used for both formatting and parsing.</p>
</td></tr><tr class="module-item"><td><a class="enum" href="enum.Numeric.html" title="chrono::format::Numeric enum">Numeric</a></td><td class="docblock-short"><p>Numeric item types.
They have associated formatting width (FW) and parsing width (PW).</p>
</td></tr><tr class="module-item"><td><a class="enum" href="enum.Pad.html" title="chrono::format::Pad enum">Pad</a></td><td class="docblock-short"><p>Padding characters for numeric items.</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.html" title="chrono::format::format fn">format</a></td><td class="docblock-short"><p>Tries to format given arguments with given formatting items.
Internally used by <code>DelayedFormat</code>.</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.format_item.html" title="chrono::format::format_item fn">format_item</a></td><td class="docblock-short"><p>Formats single formatting item</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.parse.html" title="chrono::format::parse fn">parse</a></td><td class="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>
</td></tr></table><h2 id="types" class="section-header"><a href="#types">Type Definitions</a></h2>
<table><tr class="module-item"><td><a class="type" href="type.ParseResult.html" title="chrono::format::ParseResult type">ParseResult</a></td><td class="docblock-short"><p>Same as <code>Result&lt;T, ParseError&gt;</code>.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="chrono"></div>
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink