OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-25 12:44:07 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
f4bb79d2d629ee5166f17b80ca2aa0e621d1c837
google-apis-rs/google_apis_common/index.html
Sebastian Thiel f4bb79d2d6 Update documentation
2024-03-05 21:06:01 +01:00

14 lines
13 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 `google_apis_common` crate."><title>google_apis_common - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="google_apis_common" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../google_apis_common/index.html">google_apis_common</a><span class="version">6.0.1</span></h2></div><div class="sidebar-elems"><ul class="block">
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><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="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Aliases</a></li></ul></section></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../google_apis_common/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">google_apis_common</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/google_apis_common/lib.rs.html#1-851">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><h2 id="reexports" class="section-header"><a href="#reexports">Re-exports</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.GetToken"><code>pub use auth::<a class="trait" href="auth/trait.GetToken.html" title="trait google_apis_common::auth::GetToken">GetToken</a>;</code></div></li><li><div class="item-name" id="reexport.NoToken"><code>pub use auth::<a class="struct" href="auth/struct.NoToken.html" title="struct google_apis_common::auth::NoToken">NoToken</a>;</code></div></li><li><div class="item-name" id="reexport.FieldMask"><code>pub use field_mask::<a class="struct" href="field_mask/struct.FieldMask.html" title="struct google_apis_common::field_mask::FieldMask">FieldMask</a>;</code></div></li><li><div class="item-name" id="reexport.chrono"><code>pub use <a class="mod" href="../chrono/index.html" title="mod chrono">chrono</a>;</code></div></li><li><div class="item-name" id="reexport.serde_with"><code>pub use <a class="mod" href="../serde_with/index.html" title="mod serde_with">serde_with</a>;</code></div></li><li><div class="item-name" id="reexport.oauth2"><code>pub use <a class="mod" href="../yup_oauth2/index.html" title="mod yup_oauth2">yup_oauth2</a> as oauth2;</code></div></li></ul><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="auth/index.html" title="mod google_apis_common::auth">auth</a></div><div class="desc docblock-short">Authentication for Google API endpoints</div></li><li><div class="item-name"><a class="mod" href="field_mask/index.html" title="mod google_apis_common::field_mask">field_mask</a></div></li><li><div class="item-name"><a class="mod" href="serde/index.html" title="mod google_apis_common::serde">serde</a></div></li><li><div class="item-name"><a class="mod" href="url/index.html" title="mod google_apis_common::url">url</a></div></li></ul><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Chunk.html" title="struct google_apis_common::Chunk">Chunk</a></div></li><li><div class="item-name"><a class="struct" href="struct.ContentRange.html" title="struct google_apis_common::ContentRange">ContentRange</a></div><div class="desc docblock-short">Implements the Content-Range header, for serialization only</div></li><li><div class="item-name"><a class="struct" href="struct.DefaultDelegate.html" title="struct google_apis_common::DefaultDelegate">DefaultDelegate</a></div><div class="desc docblock-short">A delegate with a conservative default implementation, which is used if no other delegate is
set.</div></li><li><div class="item-name"><a class="struct" href="struct.MethodInfo.html" title="struct google_apis_common::MethodInfo">MethodInfo</a></div><div class="desc docblock-short">Contains information about an API request.</div></li><li><div class="item-name"><a class="struct" href="struct.MultiPartReader.html" title="struct google_apis_common::MultiPartReader">MultiPartReader</a></div><div class="desc docblock-short">Provides a <code>Read</code> interface that converts multiple parts into the protocol
identified by <a href="https://tools.ietf.org/html/rfc2387">RFC2387</a>.
<strong>Note</strong>: This implementation is just as rich as it needs to be to perform uploads
to google APIs, and might not be a fully-featured implementation.</div></li><li><div class="item-name"><a class="struct" href="struct.RangeResponseHeader.html" title="struct google_apis_common::RangeResponseHeader">RangeResponseHeader</a></div></li><li><div class="item-name"><a class="struct" href="struct.ResumableUploadHelper.html" title="struct google_apis_common::ResumableUploadHelper">ResumableUploadHelper</a></div><div class="desc docblock-short">A utility type to perform a resumable upload from start to end.</div></li><li><div class="item-name"><a class="struct" href="struct.XUploadContentType.html" title="struct google_apis_common::XUploadContentType">XUploadContentType</a></div><div class="desc docblock-short">The <code>X-Upload-Content-Type</code> header.</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Error.html" title="enum google_apis_common::Error">Error</a></div></li><li><div class="item-name"><a class="enum" href="enum.Retry.html" title="enum google_apis_common::Retry">Retry</a></div></li><li><div class="item-name"><a class="enum" href="enum.UploadProtocol.html" title="enum google_apis_common::UploadProtocol">UploadProtocol</a></div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.CallBuilder.html" title="trait google_apis_common::CallBuilder">CallBuilder</a></div><div class="desc docblock-short">Identifies types which represent builders for a particular resource method</div></li><li><div class="item-name"><a class="trait" href="trait.Delegate.html" title="trait google_apis_common::Delegate">Delegate</a></div><div class="desc docblock-short">A trait specifying functionality to help controlling any request performed by the API.
The trait has a conservative default implementation.</div></li><li><div class="item-name"><a class="trait" href="trait.Hub.html" title="trait google_apis_common::Hub">Hub</a></div><div class="desc docblock-short">Identifies the Hub. There is only one per library, this trait is supposed
to make intended use more explicit.
The hub allows to access all resource methods more easily.</div></li><li><div class="item-name"><a class="trait" href="trait.MethodsBuilder.html" title="trait google_apis_common::MethodsBuilder">MethodsBuilder</a></div><div class="desc docblock-short">Identifies types for building methods of a particular resource type</div></li><li><div class="item-name"><a class="trait" href="trait.NestedType.html" title="trait google_apis_common::NestedType">NestedType</a></div><div class="desc docblock-short">Identifies types which are only used by other types internally.
They have no special meaning, this trait just marks them for completeness.</div></li><li><div class="item-name"><a class="trait" href="trait.Part.html" title="trait google_apis_common::Part">Part</a></div><div class="desc docblock-short">Identifies types which are only used as part of other types, which
usually are carrying the <code>Resource</code> trait.</div></li><li><div class="item-name"><a class="trait" href="trait.ReadSeek.html" title="trait google_apis_common::ReadSeek">ReadSeek</a></div><div class="desc docblock-short">A utility to specify reader types which provide seeking capabilities too</div></li><li><div class="item-name"><a class="trait" href="trait.RequestValue.html" title="trait google_apis_common::RequestValue">RequestValue</a></div><div class="desc docblock-short">Identifies types which are used in API requests.</div></li><li><div class="item-name"><a class="trait" href="trait.Resource.html" title="trait google_apis_common::Resource">Resource</a></div><div class="desc docblock-short">Identifies types which can be inserted and deleted.
Types with this trait are most commonly used by clients of this API.</div></li><li><div class="item-name"><a class="trait" href="trait.ResponseResult.html" title="trait google_apis_common::ResponseResult">ResponseResult</a></div><div class="desc docblock-short">Identifies types which are used in API responses.</div></li><li><div class="item-name"><a class="trait" href="trait.ToParts.html" title="trait google_apis_common::ToParts">ToParts</a></div><div class="desc docblock-short">A trait for all types that can convert themselves into a <em>parts</em> string</div></li><li><div class="item-name"><a class="trait" href="trait.UnusedType.html" title="trait google_apis_common::UnusedType">UnusedType</a></div><div class="desc docblock-short">Identifies types which are not actually used by the API
This might be a bug within the google API schema.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.get_body_as_string.html" title="fn google_apis_common::get_body_as_string">get_body_as_string</a></div></li><li><div class="item-name"><a class="fn" href="fn.remove_json_null_values.html" title="fn google_apis_common::remove_json_null_values">remove_json_null_values</a></div></li></ul><h2 id="types" class="section-header"><a href="#types">Type Aliases</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.Result.html" title="type google_apis_common::Result">Result</a></div><div class="desc docblock-short">A universal result type used as return for all calls.</div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink