Grpc.Core.Metadata.Entry.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  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.23.1.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">
  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"></div>
  58. <ul id="pagination"></ul>
  59. </div>
  60. </div>
  61. <div role="main" class="container body-content hide-when-search">
  62. <div class="sidenav hide-when-search">
  63. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  64. <div class="sidetoggle collapse" id="sidetoggle">
  65. <div id="sidetoc"></div>
  66. </div>
  67. </div>
  68. <div class="article row grid-right">
  69. <div class="col-md-10">
  70. <article class="content wrap" id="_content" data-uid="Grpc.Core.Metadata.Entry">
  71. <h1 id="Grpc_Core_Metadata_Entry" data-uid="Grpc.Core.Metadata.Entry" class="text-break">Class Metadata.Entry
  72. </h1>
  73. <div class="markdown level0 summary"><p>Metadata entry</p>
  74. </div>
  75. <div class="markdown level0 conceptual"></div>
  76. <div class="inheritance">
  77. <h5>Inheritance</h5>
  78. <div class="level0"><span class="xref">System.Object</span></div>
  79. <div class="level1"><span class="xref">Metadata.Entry</span></div>
  80. </div>
  81. <div class="inheritedMembers">
  82. <h5>Inherited Members</h5>
  83. <div>
  84. <span class="xref">System.Object.Equals(System.Object)</span>
  85. </div>
  86. <div>
  87. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  88. </div>
  89. <div>
  90. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  91. </div>
  92. <div>
  93. <span class="xref">System.Object.GetHashCode()</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Object.GetType()</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Object.MemberwiseClone()</span>
  100. </div>
  101. </div>
  102. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  103. <h6><strong>Assembly</strong>: Grpc.Core.dll</h6>
  104. <h5 id="Grpc_Core_Metadata_Entry_syntax">Syntax</h5>
  105. <div class="codewrapper">
  106. <pre><code class="lang-csharp hljs">public class Entry</code></pre>
  107. </div>
  108. <h3 id="constructors">Constructors
  109. </h3>
  110. <a id="Grpc_Core_Metadata_Entry__ctor_" data-uid="Grpc.Core.Metadata.Entry.#ctor*"></a>
  111. <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>
  112. <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>
  113. </div>
  114. <div class="markdown level1 conceptual"></div>
  115. <h5 class="decalaration">Declaration</h5>
  116. <div class="codewrapper">
  117. <pre><code class="lang-csharp hljs">public Entry(string key, byte[] valueBytes)</code></pre>
  118. </div>
  119. <h5 class="parameters">Parameters</h5>
  120. <table class="table table-bordered table-striped table-condensed">
  121. <thead>
  122. <tr>
  123. <th>Type</th>
  124. <th>Name</th>
  125. <th>Description</th>
  126. </tr>
  127. </thead>
  128. <tbody>
  129. <tr>
  130. <td><span class="xref">System.String</span></td>
  131. <td><span class="parametername">key</span></td>
  132. <td><p>Metadata key, needs to have suffix indicating a binary valued metadata entry.</p>
  133. </td>
  134. </tr>
  135. <tr>
  136. <td><span class="xref">System.Byte</span>[]</td>
  137. <td><span class="parametername">valueBytes</span></td>
  138. <td><p>Value bytes.</p>
  139. </td>
  140. </tr>
  141. </tbody>
  142. </table>
  143. <a id="Grpc_Core_Metadata_Entry__ctor_" data-uid="Grpc.Core.Metadata.Entry.#ctor*"></a>
  144. <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>
  145. <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 holding an ASCII value.</p>
  146. </div>
  147. <div class="markdown level1 conceptual"></div>
  148. <h5 class="decalaration">Declaration</h5>
  149. <div class="codewrapper">
  150. <pre><code class="lang-csharp hljs">public Entry(string key, string value)</code></pre>
  151. </div>
  152. <h5 class="parameters">Parameters</h5>
  153. <table class="table table-bordered table-striped table-condensed">
  154. <thead>
  155. <tr>
  156. <th>Type</th>
  157. <th>Name</th>
  158. <th>Description</th>
  159. </tr>
  160. </thead>
  161. <tbody>
  162. <tr>
  163. <td><span class="xref">System.String</span></td>
  164. <td><span class="parametername">key</span></td>
  165. <td><p>Metadata key, must not use suffix indicating a binary valued metadata entry.</p>
  166. </td>
  167. </tr>
  168. <tr>
  169. <td><span class="xref">System.String</span></td>
  170. <td><span class="parametername">value</span></td>
  171. <td><p>Value string. Only ASCII characters are allowed.</p>
  172. </td>
  173. </tr>
  174. </tbody>
  175. </table>
  176. <h3 id="properties">Properties
  177. </h3>
  178. <a id="Grpc_Core_Metadata_Entry_IsBinary_" data-uid="Grpc.Core.Metadata.Entry.IsBinary*"></a>
  179. <h4 id="Grpc_Core_Metadata_Entry_IsBinary" data-uid="Grpc.Core.Metadata.Entry.IsBinary">IsBinary</h4>
  180. <div class="markdown level1 summary"><p>Returns <code>true</code> if this entry is a binary-value entry.</p>
  181. </div>
  182. <div class="markdown level1 conceptual"></div>
  183. <h5 class="decalaration">Declaration</h5>
  184. <div class="codewrapper">
  185. <pre><code class="lang-csharp hljs">public bool IsBinary { get; }</code></pre>
  186. </div>
  187. <h5 class="propertyValue">Property Value</h5>
  188. <table class="table table-bordered table-striped table-condensed">
  189. <thead>
  190. <tr>
  191. <th>Type</th>
  192. <th>Description</th>
  193. </tr>
  194. </thead>
  195. <tbody>
  196. <tr>
  197. <td><span class="xref">System.Boolean</span></td>
  198. <td></td>
  199. </tr>
  200. </tbody>
  201. </table>
  202. <a id="Grpc_Core_Metadata_Entry_Key_" data-uid="Grpc.Core.Metadata.Entry.Key*"></a>
  203. <h4 id="Grpc_Core_Metadata_Entry_Key" data-uid="Grpc.Core.Metadata.Entry.Key">Key</h4>
  204. <div class="markdown level1 summary"><p>Gets the metadata entry key.</p>
  205. </div>
  206. <div class="markdown level1 conceptual"></div>
  207. <h5 class="decalaration">Declaration</h5>
  208. <div class="codewrapper">
  209. <pre><code class="lang-csharp hljs">public string Key { get; }</code></pre>
  210. </div>
  211. <h5 class="propertyValue">Property Value</h5>
  212. <table class="table table-bordered table-striped table-condensed">
  213. <thead>
  214. <tr>
  215. <th>Type</th>
  216. <th>Description</th>
  217. </tr>
  218. </thead>
  219. <tbody>
  220. <tr>
  221. <td><span class="xref">System.String</span></td>
  222. <td></td>
  223. </tr>
  224. </tbody>
  225. </table>
  226. <a id="Grpc_Core_Metadata_Entry_Value_" data-uid="Grpc.Core.Metadata.Entry.Value*"></a>
  227. <h4 id="Grpc_Core_Metadata_Entry_Value" data-uid="Grpc.Core.Metadata.Entry.Value">Value</h4>
  228. <div class="markdown level1 summary"><p>Gets the string value of this metadata entry.</p>
  229. </div>
  230. <div class="markdown level1 conceptual"></div>
  231. <h5 class="decalaration">Declaration</h5>
  232. <div class="codewrapper">
  233. <pre><code class="lang-csharp hljs">public string Value { get; }</code></pre>
  234. </div>
  235. <h5 class="propertyValue">Property Value</h5>
  236. <table class="table table-bordered table-striped table-condensed">
  237. <thead>
  238. <tr>
  239. <th>Type</th>
  240. <th>Description</th>
  241. </tr>
  242. </thead>
  243. <tbody>
  244. <tr>
  245. <td><span class="xref">System.String</span></td>
  246. <td></td>
  247. </tr>
  248. </tbody>
  249. </table>
  250. <a id="Grpc_Core_Metadata_Entry_ValueBytes_" data-uid="Grpc.Core.Metadata.Entry.ValueBytes*"></a>
  251. <h4 id="Grpc_Core_Metadata_Entry_ValueBytes" data-uid="Grpc.Core.Metadata.Entry.ValueBytes">ValueBytes</h4>
  252. <div class="markdown level1 summary"><p>Gets the binary value of this metadata entry.</p>
  253. </div>
  254. <div class="markdown level1 conceptual"></div>
  255. <h5 class="decalaration">Declaration</h5>
  256. <div class="codewrapper">
  257. <pre><code class="lang-csharp hljs">public byte[] ValueBytes { get; }</code></pre>
  258. </div>
  259. <h5 class="propertyValue">Property Value</h5>
  260. <table class="table table-bordered table-striped table-condensed">
  261. <thead>
  262. <tr>
  263. <th>Type</th>
  264. <th>Description</th>
  265. </tr>
  266. </thead>
  267. <tbody>
  268. <tr>
  269. <td><span class="xref">System.Byte</span>[]</td>
  270. <td></td>
  271. </tr>
  272. </tbody>
  273. </table>
  274. <h3 id="methods">Methods
  275. </h3>
  276. <a id="Grpc_Core_Metadata_Entry_ToString_" data-uid="Grpc.Core.Metadata.Entry.ToString*"></a>
  277. <h4 id="Grpc_Core_Metadata_Entry_ToString" data-uid="Grpc.Core.Metadata.Entry.ToString">ToString()</h4>
  278. <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>
  279. </div>
  280. <div class="markdown level1 conceptual"></div>
  281. <h5 class="decalaration">Declaration</h5>
  282. <div class="codewrapper">
  283. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  284. </div>
  285. <h5 class="returns">Returns</h5>
  286. <table class="table table-bordered table-striped table-condensed">
  287. <thead>
  288. <tr>
  289. <th>Type</th>
  290. <th>Description</th>
  291. </tr>
  292. </thead>
  293. <tbody>
  294. <tr>
  295. <td><span class="xref">System.String</span></td>
  296. <td></td>
  297. </tr>
  298. </tbody>
  299. </table>
  300. <h5 class="overrides">Overrides</h5>
  301. <div><span class="xref">System.Object.ToString()</span></div>
  302. </article>
  303. </div>
  304. <div class="hidden-sm col-md-2" role="complementary">
  305. <div class="sideaffix">
  306. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  307. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  308. </nav>
  309. </div>
  310. </div>
  311. </div>
  312. </div>
  313. <footer>
  314. <div class="grad-bottom"></div>
  315. <div class="footer">
  316. <div class="container">
  317. <span class="pull-right">
  318. <a href="#top">Back to top</a>
  319. </span>
  320. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  321. </div>
  322. </div>
  323. </footer>
  324. </div>
  325. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  326. <script type="text/javascript" src="../styles/docfx.js"></script>
  327. <script type="text/javascript" src="../styles/main.js"></script>
  328. </body>
  329. </html>