diff options
Diffstat (limited to 'target/doc/mailparse/index.html')
| -rw-r--r-- | target/doc/mailparse/index.html | 54 |
1 files changed, 41 insertions, 13 deletions
diff --git a/target/doc/mailparse/index.html b/target/doc/mailparse/index.html index f6e3ff2..84704ce 100644 --- a/target/doc/mailparse/index.html +++ b/target/doc/mailparse/index.html @@ -10,8 +10,11 @@ <title>mailparse - Rust</title> <link rel="stylesheet" type="text/css" href="../normalize.css"> - <link rel="stylesheet" type="text/css" href="../rustdoc.css"> - <link rel="stylesheet" type="text/css" href="../main.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="../main.css" id="themeStyle"> + <script src="../storage.js"></script> @@ -28,10 +31,18 @@ <nav class="sidebar"> + <div class="sidebar-menu">☰</div> - <p class='location'>Crate mailparse</p><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'mailparse', ty: 'mod', relpath: '../'};</script> + <p class='location'>Crate mailparse</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="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'mailparse', 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"> @@ -48,7 +59,7 @@ <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs"> [<span class='inner'>−</span>] </a> - </span><a class='srclink' href='../src/mailparse/lib.rs.html#1-1214' title='goto source code'>[src]</a></span></h1> + </span><a class='srclink' href='../src/mailparse/lib.rs.html#1-1213' title='goto source code'>[src]</a></span></h1> <h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2> <table> <tr class=' module-item'> @@ -60,6 +71,7 @@ It holds slices into the raw byte array passed to parse_mail, and so the lifetime of this struct must be contained within the lifetime of the raw input. There are additional accessor functions on this struct to extract the data as Rust strings.</p> + </td> </tr> <tr class=' module-item'> @@ -69,6 +81,7 @@ the data as Rust strings.</p> <p>A struct to hold a more structured representation of the Content-Disposition header. This is provided mostly as a convenience since this metadata is usually needed to interpret the message body properly.</p> + </td> </tr> <tr class=' module-item'> @@ -78,6 +91,7 @@ needed to interpret the message body properly.</p> <p>A struct to hold a more structured representation of the Content-Type header. This is provided mostly as a convenience since this metadata is usually needed to interpret the message body properly.</p> + </td> </tr> <tr class=' module-item'> @@ -88,6 +102,7 @@ needed to interpret the message body properly.</p> since MIME allows for nested multipart messages, a tree-like structure is necessary to represent it properly. This struct accomplishes that by holding a vector of other ParsedMail structures for the subparts.</p> + </td> </tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2> <table> @@ -97,9 +112,10 @@ a vector of other ParsedMail structures for the subparts.</p> <td class='docblock-short'> <p>The possible disposition types in a Content-Disposition header. A more comprehensive list of IANA-recognized types can be found at -<a href="https://www.iana.org/assignments/cont-disp/cont-disp.xhtml">https://www.iana.org/assignments/cont-disp/cont-disp.xhtml</a>. This library +https://www.iana.org/assignments/cont-disp/cont-disp.xhtml. This library only enumerates the types most commonly found in email messages, and provides the <code>Extension</code> value for holding all other types.</p> + </td> </tr> <tr class=' module-item'> @@ -108,6 +124,7 @@ provides the <code>Extension</code> value for holding all other types.</p> <td class='docblock-short'> <p>An error type that represents the different kinds of errors that may be encountered during message parsing.</p> + </td> </tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2> <table> @@ -118,6 +135,7 @@ encountered during message parsing.</p> <p>A trait that is implemented by the Vec<MailHeader> returned by the parse_headers function. It provides a map-like interface to look up header values by their name.</p> + </td> </tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2> <table> @@ -128,6 +146,7 @@ name.</p> <p>Convert a date field from an email header into a UNIX epoch timestamp. This function handles the most common formatting of date fields found in email headers. It may fail to parse some of the more creative formattings.</p> + </td> </tr> <tr class=' module-item'> @@ -137,6 +156,7 @@ email headers. It may fail to parse some of the more creative formattings.</p> <p>Helper method to parse a header value as a Content-Disposition header. The disposition defaults to "inline" if no disposition parameter is provided in the header value.</p> + </td> </tr> <tr class=' module-item'> @@ -144,10 +164,11 @@ value.</p> title='fn mailparse::parse_content_type'>parse_content_type</a></td> <td class='docblock-short'> <p>Helper method to parse a header value as a Content-Type header. Note that -the returned object's <code>params</code> map will contain a charset key if a charset +the returned object's <code>params</code> map will contain a charset key if a charset was explicitly specified in the header; otherwise the <code>params</code> map will not contain a charset key. Regardless, the <code>charset</code> field will contain a charset - either the one explicitly specified or the default of "us-ascii".</p> + </td> </tr> <tr class=' module-item'> @@ -162,6 +183,7 @@ expected to start. If you just want to parse a single header, you can ignore the second component of the tuple, which is the index of the next header. Error values are returned if the data could not be successfully interpreted as a MIME key-value pair.</p> + </td> </tr> <tr class=' module-item'> @@ -179,6 +201,7 @@ returns the index at which the message body is expected to start. If you just care about the headers, you can ignore the second component of the returned tuple. Error values are returned if there was some sort of parsing error.</p> + </td> </tr> <tr class=' module-item'> @@ -189,6 +212,7 @@ Error values are returned if there was some sort of parsing error.</p> This function takes the raw data making up the message body and returns a structured version of it, which allows easily accessing the header and body information as needed.</p> + </td> </tr></table></section> <section id='search' class="content hidden"></section> @@ -203,18 +227,22 @@ information as needed.</p> <h2>Keyboard Shortcuts</h2> <dl> - <dt>?</dt> + <dt><kbd>?</kbd></dt> <dd>Show this help dialog</dd> - <dt>S</dt> + <dt><kbd>S</kbd></dt> <dd>Focus the search field</dd> - <dt>⇤</dt> + <dt><kbd>↑</kbd></dt> <dd>Move up in search results</dd> - <dt>⇥</dt> + <dt><kbd>↓</kbd></dt> <dd>Move down in search results</dd> - <dt>⏎</dt> + <dt><kbd>↹</kbd></dt> + <dd>Switch tab</dd> + <dt><kbd>⏎</kbd></dt> <dd>Go to active search result</dd> - <dt>+</dt> - <dd>Collapse/expand all sections</dd> + <dt><kbd>+</kbd></dt> + <dd>Expand all sections</dd> + <dt><kbd>-</kbd></dt> + <dd>Collapse all sections</dd> </dl> </div> |