blob: 096678abda74183d9886f8202420cb5edc711dcb [file] [log] [blame]
<!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="Contains data structures and utilities for handling gRPC custom metadata."><meta name="keywords" content="rust, rustlang, rust-lang, metadata"><title>tonic::metadata - 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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../tonic/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/tokio-rs/website/master/public/img/icons/tonic.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../tonic/index.html"><div class="logo-container">
<img src="https://raw.githubusercontent.com/tokio-rs/website/master/public/img/icons/tonic.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module metadata</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#types">Type Definitions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">tonic</a>::<wbr><a class="mod" href="#">metadata</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></h1><span class="out-of-band"><a class="srclink" href="../../src/tonic/metadata/mod.rs.html#1-43">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Contains data structures and utilities for handling gRPC custom metadata.</p>
</div></details><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="errors/index.html" title="tonic::metadata::errors mod">errors</a></div><div class="item-right docblock-short">The metadata::errors module contains types for errors that can occur
while handling gRPC custom metadata.</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.GetAll.html" title="tonic::metadata::GetAll struct">GetAll</a></div><div class="item-right docblock-short">A view to all values stored in a single entry.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Iter.html" title="tonic::metadata::Iter struct">Iter</a></div><div class="item-right docblock-short"><code>MetadataMap</code> entry iterator.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IterMut.html" title="tonic::metadata::IterMut struct">IterMut</a></div><div class="item-right docblock-short"><code>MetadataMap</code> entry iterator.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Keys.html" title="tonic::metadata::Keys struct">Keys</a></div><div class="item-right docblock-short">An iterator over <code>MetadataMap</code> keys.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MetadataKey.html" title="tonic::metadata::MetadataKey struct">MetadataKey</a></div><div class="item-right docblock-short">Represents a custom metadata field name.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MetadataMap.html" title="tonic::metadata::MetadataMap struct">MetadataMap</a></div><div class="item-right docblock-short">A set of gRPC custom metadata entries.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MetadataValue.html" title="tonic::metadata::MetadataValue struct">MetadataValue</a></div><div class="item-right docblock-short">Represents a custom metadata field value.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OccupiedEntry.html" title="tonic::metadata::OccupiedEntry struct">OccupiedEntry</a></div><div class="item-right docblock-short">A view into a single occupied location in a <code>MetadataMap</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.VacantEntry.html" title="tonic::metadata::VacantEntry struct">VacantEntry</a></div><div class="item-right docblock-short">A view into a single empty location in a <code>MetadataMap</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ValueDrain.html" title="tonic::metadata::ValueDrain struct">ValueDrain</a></div><div class="item-right docblock-short">A drain iterator of all values associated with a single metadata key.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ValueIter.html" title="tonic::metadata::ValueIter struct">ValueIter</a></div><div class="item-right docblock-short">An iterator of all values associated with a single metadata key.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Values.html" title="tonic::metadata::Values struct">Values</a></div><div class="item-right docblock-short"><code>MetadataMap</code> value iterator.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ValuesMut.html" title="tonic::metadata::ValuesMut struct">ValuesMut</a></div><div class="item-right docblock-short"><code>MetadataMap</code> value iterator.</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.Entry.html" title="tonic::metadata::Entry enum">Entry</a></div><div class="item-right docblock-short">A view into a single location in a <code>MetadataMap</code>, which may be vacant or
occupied.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.KeyAndMutValueRef.html" title="tonic::metadata::KeyAndMutValueRef enum">KeyAndMutValueRef</a></div><div class="item-right docblock-short">Reference to a key and an associated value in a <code>MetadataMap</code>. It can point
to either an ascii or a binary (“*-bin”) key.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.KeyAndValueRef.html" title="tonic::metadata::KeyAndValueRef enum">KeyAndValueRef</a></div><div class="item-right docblock-short">Reference to a key and an associated value in a <code>MetadataMap</code>. It can point
to either an ascii or a binary (“*-bin”) key.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.KeyRef.html" title="tonic::metadata::KeyRef enum">KeyRef</a></div><div class="item-right docblock-short">Reference to a key in a <code>MetadataMap</code>. It can point
to either an ascii or a binary (“*-bin”) key.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ValueRef.html" title="tonic::metadata::ValueRef enum">ValueRef</a></div><div class="item-right docblock-short">Reference to a value in a <code>MetadataMap</code>. It can point
to either an ascii or a binary (“*-bin” key) value.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ValueRefMut.html" title="tonic::metadata::ValueRefMut enum">ValueRefMut</a></div><div class="item-right docblock-short">Reference to a value in a <code>MetadataMap</code>. It can point
to either an ascii or a binary (“*-bin” key) value.</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.AsciiMetadataKey.html" title="tonic::metadata::AsciiMetadataKey type">AsciiMetadataKey</a></div><div class="item-right docblock-short">An ascii metadata key.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.AsciiMetadataValue.html" title="tonic::metadata::AsciiMetadataValue type">AsciiMetadataValue</a></div><div class="item-right docblock-short">An ascii metadata value.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.BinaryMetadataKey.html" title="tonic::metadata::BinaryMetadataKey type">BinaryMetadataKey</a></div><div class="item-right docblock-short">A binary metadata key.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.BinaryMetadataValue.html" title="tonic::metadata::BinaryMetadataValue type">BinaryMetadataValue</a></div><div class="item-right docblock-short">A binary metadata value.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tonic" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>