Grpc.Core.Metadata.Entry.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class Metadata.Entry
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Metadata.Entry
  11. | gRPC C# ">
  12. <meta name="generator" content="docfx 2.36.0.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../index.html">
  34. <img id="logo" class="svg" src="../logo.svg" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Grpc.Core.Metadata.Entry">
  73. <h1 id="Grpc_Core_Metadata_Entry" data-uid="Grpc.Core.Metadata.Entry" class="text-break">Class Metadata.Entry
  74. </h1>
  75. <div class="markdown level0 summary"><p>Metadata entry</p>
  76. </div>
  77. <div class="markdown level0 conceptual"></div>
  78. <div class="inheritance">
  79. <h5>Inheritance</h5>
  80. <div class="level0"><span class="xref">System.Object</span></div>
  81. <div class="level1"><span class="xref">Metadata.Entry</span></div>
  82. </div>
  83. <div class="inheritedMembers">
  84. <h5>Inherited Members</h5>
  85. <div>
  86. <span class="xref">System.Object.Equals(System.Object)</span>
  87. </div>
  88. <div>
  89. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  90. </div>
  91. <div>
  92. <span class="xref">System.Object.GetHashCode()</span>
  93. </div>
  94. <div>
  95. <span class="xref">System.Object.GetType()</span>
  96. </div>
  97. <div>
  98. <span class="xref">System.Object.MemberwiseClone()</span>
  99. </div>
  100. <div>
  101. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  102. </div>
  103. </div>
  104. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  105. <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  106. <h5 id="Grpc_Core_Metadata_Entry_syntax">Syntax</h5>
  107. <div class="codewrapper">
  108. <pre><code class="lang-csharp hljs">public class Entry</code></pre>
  109. </div>
  110. <h3 id="constructors">Constructors
  111. </h3>
  112. <a id="Grpc_Core_Metadata_Entry__ctor_" data-uid="Grpc.Core.Metadata.Entry.#ctor*"></a>
  113. <h4 id="Grpc_Core_Metadata_Entry__ctor_System_String_System_Byte___" data-uid="Grpc.Core.Metadata.Entry.#ctor(System.String,System.Byte[])">Entry(String, Byte[])</h4>
  114. <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a> struct with a binary value.</p>
  115. </div>
  116. <div class="markdown level1 conceptual"></div>
  117. <h5 class="decalaration">Declaration</h5>
  118. <div class="codewrapper">
  119. <pre><code class="lang-csharp hljs">public Entry(string key, byte[] valueBytes)</code></pre>
  120. </div>
  121. <h5 class="parameters">Parameters</h5>
  122. <table class="table table-bordered table-striped table-condensed">
  123. <thead>
  124. <tr>
  125. <th>Type</th>
  126. <th>Name</th>
  127. <th>Description</th>
  128. </tr>
  129. </thead>
  130. <tbody>
  131. <tr>
  132. <td><span class="xref">System.String</span></td>
  133. <td><span class="parametername">key</span></td>
  134. <td><p>Metadata key. Gets converted to lowercase. Needs to have suffix indicating a binary valued metadata entry. Can only contain lowercase alphanumeric characters, underscores, hyphens and dots.</p>
  135. </td>
  136. </tr>
  137. <tr>
  138. <td><span class="xref">System.Byte</span>[]</td>
  139. <td><span class="parametername">valueBytes</span></td>
  140. <td><p>Value bytes.</p>
  141. </td>
  142. </tr>
  143. </tbody>
  144. </table>
  145. <a id="Grpc_Core_Metadata_Entry__ctor_" data-uid="Grpc.Core.Metadata.Entry.#ctor*"></a>
  146. <h4 id="Grpc_Core_Metadata_Entry__ctor_System_String_System_String_" data-uid="Grpc.Core.Metadata.Entry.#ctor(System.String,System.String)">Entry(String, String)</h4>
  147. <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a> struct with an ASCII value.</p>
  148. </div>
  149. <div class="markdown level1 conceptual"></div>
  150. <h5 class="decalaration">Declaration</h5>
  151. <div class="codewrapper">
  152. <pre><code class="lang-csharp hljs">public Entry(string key, string value)</code></pre>
  153. </div>
  154. <h5 class="parameters">Parameters</h5>
  155. <table class="table table-bordered table-striped table-condensed">
  156. <thead>
  157. <tr>
  158. <th>Type</th>
  159. <th>Name</th>
  160. <th>Description</th>
  161. </tr>
  162. </thead>
  163. <tbody>
  164. <tr>
  165. <td><span class="xref">System.String</span></td>
  166. <td><span class="parametername">key</span></td>
  167. <td><p>Metadata key. Gets converted to lowercase. Must not use suffix indicating a binary valued metadata entry. Can only contain lowercase alphanumeric characters, underscores, hyphens and dots.</p>
  168. </td>
  169. </tr>
  170. <tr>
  171. <td><span class="xref">System.String</span></td>
  172. <td><span class="parametername">value</span></td>
  173. <td><p>Value string. Only ASCII characters are allowed.</p>
  174. </td>
  175. </tr>
  176. </tbody>
  177. </table>
  178. <h3 id="properties">Properties
  179. </h3>
  180. <a id="Grpc_Core_Metadata_Entry_IsBinary_" data-uid="Grpc.Core.Metadata.Entry.IsBinary*"></a>
  181. <h4 id="Grpc_Core_Metadata_Entry_IsBinary" data-uid="Grpc.Core.Metadata.Entry.IsBinary">IsBinary</h4>
  182. <div class="markdown level1 summary"><p>Returns <code>true</code> if this entry is a binary-value entry.</p>
  183. </div>
  184. <div class="markdown level1 conceptual"></div>
  185. <h5 class="decalaration">Declaration</h5>
  186. <div class="codewrapper">
  187. <pre><code class="lang-csharp hljs">public bool IsBinary { get; }</code></pre>
  188. </div>
  189. <h5 class="propertyValue">Property Value</h5>
  190. <table class="table table-bordered table-striped table-condensed">
  191. <thead>
  192. <tr>
  193. <th>Type</th>
  194. <th>Description</th>
  195. </tr>
  196. </thead>
  197. <tbody>
  198. <tr>
  199. <td><span class="xref">System.Boolean</span></td>
  200. <td></td>
  201. </tr>
  202. </tbody>
  203. </table>
  204. <a id="Grpc_Core_Metadata_Entry_Key_" data-uid="Grpc.Core.Metadata.Entry.Key*"></a>
  205. <h4 id="Grpc_Core_Metadata_Entry_Key" data-uid="Grpc.Core.Metadata.Entry.Key">Key</h4>
  206. <div class="markdown level1 summary"><p>Gets the metadata entry key.</p>
  207. </div>
  208. <div class="markdown level1 conceptual"></div>
  209. <h5 class="decalaration">Declaration</h5>
  210. <div class="codewrapper">
  211. <pre><code class="lang-csharp hljs">public string Key { get; }</code></pre>
  212. </div>
  213. <h5 class="propertyValue">Property Value</h5>
  214. <table class="table table-bordered table-striped table-condensed">
  215. <thead>
  216. <tr>
  217. <th>Type</th>
  218. <th>Description</th>
  219. </tr>
  220. </thead>
  221. <tbody>
  222. <tr>
  223. <td><span class="xref">System.String</span></td>
  224. <td></td>
  225. </tr>
  226. </tbody>
  227. </table>
  228. <a id="Grpc_Core_Metadata_Entry_Value_" data-uid="Grpc.Core.Metadata.Entry.Value*"></a>
  229. <h4 id="Grpc_Core_Metadata_Entry_Value" data-uid="Grpc.Core.Metadata.Entry.Value">Value</h4>
  230. <div class="markdown level1 summary"><p>Gets the string value of this metadata entry.
  231. If the metadata entry is binary then an exception is thrown.</p>
  232. </div>
  233. <div class="markdown level1 conceptual"></div>
  234. <h5 class="decalaration">Declaration</h5>
  235. <div class="codewrapper">
  236. <pre><code class="lang-csharp hljs">public string Value { get; }</code></pre>
  237. </div>
  238. <h5 class="propertyValue">Property Value</h5>
  239. <table class="table table-bordered table-striped table-condensed">
  240. <thead>
  241. <tr>
  242. <th>Type</th>
  243. <th>Description</th>
  244. </tr>
  245. </thead>
  246. <tbody>
  247. <tr>
  248. <td><span class="xref">System.String</span></td>
  249. <td></td>
  250. </tr>
  251. </tbody>
  252. </table>
  253. <a id="Grpc_Core_Metadata_Entry_ValueBytes_" data-uid="Grpc.Core.Metadata.Entry.ValueBytes*"></a>
  254. <h4 id="Grpc_Core_Metadata_Entry_ValueBytes" data-uid="Grpc.Core.Metadata.Entry.ValueBytes">ValueBytes</h4>
  255. <div class="markdown level1 summary"><p>Gets the binary value of this metadata entry.
  256. If the metadata entry is not binary the string value will be returned as ASCII encoded bytes.</p>
  257. </div>
  258. <div class="markdown level1 conceptual"></div>
  259. <h5 class="decalaration">Declaration</h5>
  260. <div class="codewrapper">
  261. <pre><code class="lang-csharp hljs">public byte[] ValueBytes { get; }</code></pre>
  262. </div>
  263. <h5 class="propertyValue">Property Value</h5>
  264. <table class="table table-bordered table-striped table-condensed">
  265. <thead>
  266. <tr>
  267. <th>Type</th>
  268. <th>Description</th>
  269. </tr>
  270. </thead>
  271. <tbody>
  272. <tr>
  273. <td><span class="xref">System.Byte</span>[]</td>
  274. <td></td>
  275. </tr>
  276. </tbody>
  277. </table>
  278. <h3 id="methods">Methods
  279. </h3>
  280. <a id="Grpc_Core_Metadata_Entry_ToString_" data-uid="Grpc.Core.Metadata.Entry.ToString*"></a>
  281. <h4 id="Grpc_Core_Metadata_Entry_ToString" data-uid="Grpc.Core.Metadata.Entry.ToString">ToString()</h4>
  282. <div class="markdown level1 summary"><p>Returns a <span class="xref">System.String</span> that represents the current <a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a>.</p>
  283. </div>
  284. <div class="markdown level1 conceptual"></div>
  285. <h5 class="decalaration">Declaration</h5>
  286. <div class="codewrapper">
  287. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  288. </div>
  289. <h5 class="returns">Returns</h5>
  290. <table class="table table-bordered table-striped table-condensed">
  291. <thead>
  292. <tr>
  293. <th>Type</th>
  294. <th>Description</th>
  295. </tr>
  296. </thead>
  297. <tbody>
  298. <tr>
  299. <td><span class="xref">System.String</span></td>
  300. <td></td>
  301. </tr>
  302. </tbody>
  303. </table>
  304. <h5 class="overrides">Overrides</h5>
  305. <div><span class="xref">System.Object.ToString()</span></div>
  306. </article>
  307. </div>
  308. <div class="hidden-sm col-md-2" role="complementary">
  309. <div class="sideaffix">
  310. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  311. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  312. </nav>
  313. </div>
  314. </div>
  315. </div>
  316. </div>
  317. <footer>
  318. <div class="grad-bottom"></div>
  319. <div class="footer">
  320. <div class="container">
  321. <span class="pull-right">
  322. <a href="#top">Back to top</a>
  323. </span>
  324. <span>Generated by <strong>DocFX</strong></span>
  325. </div>
  326. </div>
  327. </footer>
  328. </div>
  329. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  330. <script type="text/javascript" src="../styles/docfx.js"></script>
  331. <script type="text/javascript" src="../styles/main.js"></script>
  332. </body>
  333. </html>