protobuf-net.xml 154 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>protobuf-net</name>
  5. </assembly>
  6. <members>
  7. <member name="T:ProtoBuf.BclHelpers">
  8. <summary>
  9. Provides support for common .NET types that do not have a direct representation
  10. in protobuf, using the definitions from bcl.proto
  11. </summary>
  12. </member>
  13. <member name="M:ProtoBuf.BclHelpers.GetUninitializedObject(System.Type)">
  14. <summary>
  15. Creates a new instance of the specified type, bypassing the constructor.
  16. </summary>
  17. <param name="type">The type to create</param>
  18. <returns>The new instance</returns>
  19. <exception cref="T:System.NotSupportedException">If the platform does not support constructor-skipping</exception>
  20. </member>
  21. <member name="M:ProtoBuf.BclHelpers.WriteTimeSpan(System.TimeSpan,ProtoBuf.ProtoWriter)">
  22. <summary>
  23. Writes a TimeSpan to a protobuf stream
  24. </summary>
  25. </member>
  26. <member name="M:ProtoBuf.BclHelpers.ReadTimeSpan(ProtoBuf.ProtoReader)">
  27. <summary>
  28. Parses a TimeSpan from a protobuf stream
  29. </summary>
  30. </member>
  31. <member name="M:ProtoBuf.BclHelpers.ReadDateTime(ProtoBuf.ProtoReader)">
  32. <summary>
  33. Parses a DateTime from a protobuf stream
  34. </summary>
  35. </member>
  36. <member name="M:ProtoBuf.BclHelpers.WriteDateTime(System.DateTime,ProtoBuf.ProtoWriter)">
  37. <summary>
  38. Writes a DateTime to a protobuf stream
  39. </summary>
  40. </member>
  41. <member name="M:ProtoBuf.BclHelpers.ReadDecimal(ProtoBuf.ProtoReader)">
  42. <summary>
  43. Parses a decimal from a protobuf stream
  44. </summary>
  45. </member>
  46. <member name="M:ProtoBuf.BclHelpers.WriteDecimal(System.Decimal,ProtoBuf.ProtoWriter)">
  47. <summary>
  48. Writes a decimal to a protobuf stream
  49. </summary>
  50. </member>
  51. <member name="M:ProtoBuf.BclHelpers.WriteGuid(System.Guid,ProtoBuf.ProtoWriter)">
  52. <summary>
  53. Writes a Guid to a protobuf stream
  54. </summary>
  55. </member>
  56. <member name="M:ProtoBuf.BclHelpers.ReadGuid(ProtoBuf.ProtoReader)">
  57. <summary>
  58. Parses a Guid from a protobuf stream
  59. </summary>
  60. </member>
  61. <member name="M:ProtoBuf.BclHelpers.ReadNetObject(System.Object,ProtoBuf.ProtoReader,System.Int32,System.Type,ProtoBuf.BclHelpers.NetObjectOptions)">
  62. <summary>
  63. Reads an *implementation specific* bundled .NET object, including (as options) type-metadata, identity/re-use, etc.
  64. </summary>
  65. </member>
  66. <member name="M:ProtoBuf.BclHelpers.WriteNetObject(System.Object,ProtoBuf.ProtoWriter,System.Int32,ProtoBuf.BclHelpers.NetObjectOptions)">
  67. <summary>
  68. Writes an *implementation specific* bundled .NET object, including (as options) type-metadata, identity/re-use, etc.
  69. </summary>
  70. </member>
  71. <member name="T:ProtoBuf.BclHelpers.NetObjectOptions">
  72. <summary>
  73. Optional behaviours that introduce .NET-specific functionality
  74. </summary>
  75. </member>
  76. <member name="F:ProtoBuf.BclHelpers.NetObjectOptions.None">
  77. <summary>
  78. No special behaviour
  79. </summary>
  80. </member>
  81. <member name="F:ProtoBuf.BclHelpers.NetObjectOptions.AsReference">
  82. <summary>
  83. Enables full object-tracking/full-graph support.
  84. </summary>
  85. </member>
  86. <member name="F:ProtoBuf.BclHelpers.NetObjectOptions.DynamicType">
  87. <summary>
  88. Embeds the type information into the stream, allowing usage with types not known in advance.
  89. </summary>
  90. </member>
  91. <member name="F:ProtoBuf.BclHelpers.NetObjectOptions.UseConstructor">
  92. <summary>
  93. If false, the constructor for the type is bypassed during deserialization, meaning any field initializers
  94. or other initialization code is skipped.
  95. </summary>
  96. </member>
  97. <member name="T:ProtoBuf.BufferExtension">
  98. <summary>
  99. Provides a simple buffer-based implementation of an <see cref="T:ProtoBuf.IExtension">extension</see> object.
  100. </summary>
  101. </member>
  102. <member name="T:ProtoBuf.IExtension">
  103. <summary>
  104. Provides addition capability for supporting unexpected fields during
  105. protocol-buffer serialization/deserialization. This allows for loss-less
  106. round-trip/merge, even when the data is not fully understood.
  107. </summary>
  108. </member>
  109. <member name="M:ProtoBuf.IExtension.BeginAppend">
  110. <summary>
  111. Requests a stream into which any unexpected fields can be persisted.
  112. </summary>
  113. <returns>A new stream suitable for storing data.</returns>
  114. </member>
  115. <member name="M:ProtoBuf.IExtension.EndAppend(System.IO.Stream,System.Boolean)">
  116. <summary>
  117. Indicates that all unexpected fields have now been stored. The
  118. implementing class is responsible for closing the stream. If
  119. "commit" is not true the data may be discarded.
  120. </summary>
  121. <param name="stream">The stream originally obtained by BeginAppend.</param>
  122. <param name="commit">True if the append operation completed successfully.</param>
  123. </member>
  124. <member name="M:ProtoBuf.IExtension.BeginQuery">
  125. <summary>
  126. Requests a stream of the unexpected fields previously stored.
  127. </summary>
  128. <returns>A prepared stream of the unexpected fields.</returns>
  129. </member>
  130. <member name="M:ProtoBuf.IExtension.EndQuery(System.IO.Stream)">
  131. <summary>
  132. Indicates that all unexpected fields have now been read. The
  133. implementing class is responsible for closing the stream.
  134. </summary>
  135. <param name="stream">The stream originally obtained by BeginQuery.</param>
  136. </member>
  137. <member name="M:ProtoBuf.IExtension.GetLength">
  138. <summary>
  139. Requests the length of the raw binary stream; this is used
  140. when serializing sub-entities to indicate the expected size.
  141. </summary>
  142. <returns>The length of the binary stream representing unexpected data.</returns>
  143. </member>
  144. <member name="T:ProtoBuf.ProtoBeforeSerializationAttribute">
  145. <summary>Specifies a method on the root-contract in an hierarchy to be invoked before serialization.</summary>
  146. </member>
  147. <member name="T:ProtoBuf.ProtoAfterSerializationAttribute">
  148. <summary>Specifies a method on the root-contract in an hierarchy to be invoked after serialization.</summary>
  149. </member>
  150. <member name="T:ProtoBuf.ProtoBeforeDeserializationAttribute">
  151. <summary>Specifies a method on the root-contract in an hierarchy to be invoked before deserialization.</summary>
  152. </member>
  153. <member name="T:ProtoBuf.ProtoAfterDeserializationAttribute">
  154. <summary>Specifies a method on the root-contract in an hierarchy to be invoked after deserialization.</summary>
  155. </member>
  156. <member name="M:ProtoBuf.Compiler.CompilerContext.LoadNullRef">
  157. <summary>
  158. Pushes a null reference onto the stack. Note that this should only
  159. be used to return a null (or set a variable to null); for null-tests
  160. use BranchIfTrue / BranchIfFalse.
  161. </summary>
  162. </member>
  163. <member name="M:ProtoBuf.Compiler.CompilerContext.UsingBlock.#ctor(ProtoBuf.Compiler.CompilerContext,ProtoBuf.Compiler.Local)">
  164. <summary>
  165. Creates a new "using" block (equivalent) around a variable;
  166. the variable must exist, and note that (unlike in C#) it is
  167. the variables *final* value that gets disposed. If you need
  168. *original* disposal, copy your variable first.
  169. It is the callers responsibility to ensure that the variable's
  170. scope fully-encapsulates the "using"; if not, the variable
  171. may be re-used (and thus re-assigned) unexpectedly.
  172. </summary>
  173. </member>
  174. <member name="T:ProtoBuf.DataFormat">
  175. <summary>
  176. Sub-format to use when serializing/deserializing data
  177. </summary>
  178. </member>
  179. <member name="F:ProtoBuf.DataFormat.Default">
  180. <summary>
  181. Uses the default encoding for the data-type.
  182. </summary>
  183. </member>
  184. <member name="F:ProtoBuf.DataFormat.ZigZag">
  185. <summary>
  186. When applied to signed integer-based data (including Decimal), this
  187. indicates that zigzag variant encoding will be used. This means that values
  188. with small magnitude (regardless of sign) take a small amount
  189. of space to encode.
  190. </summary>
  191. </member>
  192. <member name="F:ProtoBuf.DataFormat.TwosComplement">
  193. <summary>
  194. When applied to signed integer-based data (including Decimal), this
  195. indicates that two's-complement variant encoding will be used.
  196. This means that any -ve number will take 10 bytes (even for 32-bit),
  197. so should only be used for compatibility.
  198. </summary>
  199. </member>
  200. <member name="F:ProtoBuf.DataFormat.FixedSize">
  201. <summary>
  202. When applied to signed integer-based data (including Decimal), this
  203. indicates that a fixed amount of space will be used.
  204. </summary>
  205. </member>
  206. <member name="F:ProtoBuf.DataFormat.Group">
  207. <summary>
  208. When applied to a sub-message, indicates that the value should be treated
  209. as group-delimited.
  210. </summary>
  211. </member>
  212. <member name="T:ProtoBuf.Extensible">
  213. <summary>
  214. Simple base class for supporting unexpected fields allowing
  215. for loss-less round-tips/merge, even if the data is not understod.
  216. The additional fields are (by default) stored in-memory in a buffer.
  217. </summary>
  218. <remarks>As an example of an alternative implementation, you might
  219. choose to use the file system (temporary files) as the back-end, tracking
  220. only the paths [such an object would ideally be IDisposable and use
  221. a finalizer to ensure that the files are removed].</remarks>
  222. <seealso cref="T:ProtoBuf.IExtensible"/>
  223. </member>
  224. <member name="T:ProtoBuf.IExtensible">
  225. <summary>
  226. Indicates that the implementing type has support for protocol-buffer
  227. <see cref="T:ProtoBuf.IExtension">extensions</see>.
  228. </summary>
  229. <remarks>Can be implemented by deriving from Extensible.</remarks>
  230. </member>
  231. <member name="M:ProtoBuf.IExtensible.GetExtensionObject(System.Boolean)">
  232. <summary>
  233. Retrieves the <see cref="T:ProtoBuf.IExtension">extension</see> object for the current
  234. instance, optionally creating it if it does not already exist.
  235. </summary>
  236. <param name="createIfMissing">Should a new extension object be
  237. created if it does not already exist?</param>
  238. <returns>The extension object if it exists (or was created), or null
  239. if the extension object does not exist or is not available.</returns>
  240. <remarks>The <c>createIfMissing</c> argument is false during serialization,
  241. and true during deserialization upon encountering unexpected fields.</remarks>
  242. </member>
  243. <member name="M:ProtoBuf.Extensible.GetExtensionObject(System.Boolean)">
  244. <summary>
  245. Retrieves the <see cref="T:ProtoBuf.IExtension">extension</see> object for the current
  246. instance, optionally creating it if it does not already exist.
  247. </summary>
  248. <param name="createIfMissing">Should a new extension object be
  249. created if it does not already exist?</param>
  250. <returns>The extension object if it exists (or was created), or null
  251. if the extension object does not exist or is not available.</returns>
  252. <remarks>The <c>createIfMissing</c> argument is false during serialization,
  253. and true during deserialization upon encountering unexpected fields.</remarks>
  254. </member>
  255. <member name="M:ProtoBuf.Extensible.GetExtensionObject(ProtoBuf.IExtension@,System.Boolean)">
  256. <summary>
  257. Provides a simple, default implementation for <see cref="T:ProtoBuf.IExtension">extension</see> support,
  258. optionally creating it if it does not already exist. Designed to be called by
  259. classes implementing <see cref="T:ProtoBuf.IExtensible"/>.
  260. </summary>
  261. <param name="createIfMissing">Should a new extension object be
  262. created if it does not already exist?</param>
  263. <param name="extensionObject">The extension field to check (and possibly update).</param>
  264. <returns>The extension object if it exists (or was created), or null
  265. if the extension object does not exist or is not available.</returns>
  266. <remarks>The <c>createIfMissing</c> argument is false during serialization,
  267. and true during deserialization upon encountering unexpected fields.</remarks>
  268. </member>
  269. <member name="M:ProtoBuf.Extensible.AppendValue``1(ProtoBuf.IExtensible,System.Int32,``0)">
  270. <summary>
  271. Appends the value as an additional (unexpected) data-field for the instance.
  272. Note that for non-repeated sub-objects, this equates to a merge operation;
  273. for repeated sub-objects this adds a new instance to the set; for simple
  274. values the new value supercedes the old value.
  275. </summary>
  276. <remarks>Note that appending a value does not remove the old value from
  277. the stream; avoid repeatedly appending values for the same field.</remarks>
  278. <typeparam name="TValue">The type of the value to append.</typeparam>
  279. <param name="instance">The extensible object to append the value to.</param>
  280. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  281. <param name="value">The value to append.</param>
  282. </member>
  283. <member name="M:ProtoBuf.Extensible.AppendValue``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,``0)">
  284. <summary>
  285. Appends the value as an additional (unexpected) data-field for the instance.
  286. Note that for non-repeated sub-objects, this equates to a merge operation;
  287. for repeated sub-objects this adds a new instance to the set; for simple
  288. values the new value supercedes the old value.
  289. </summary>
  290. <remarks>Note that appending a value does not remove the old value from
  291. the stream; avoid repeatedly appending values for the same field.</remarks>
  292. <typeparam name="TValue">The data-type of the field.</typeparam>
  293. <param name="format">The data-format to use when encoding the value.</param>
  294. <param name="instance">The extensible object to append the value to.</param>
  295. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  296. <param name="value">The value to append.</param>
  297. </member>
  298. <member name="M:ProtoBuf.Extensible.GetValue``1(ProtoBuf.IExtensible,System.Int32)">
  299. <summary>
  300. Queries an extensible object for an additional (unexpected) data-field for the instance.
  301. The value returned is the composed value after merging any duplicated content; if the
  302. value is "repeated" (a list), then use GetValues instead.
  303. </summary>
  304. <typeparam name="TValue">The data-type of the field.</typeparam>
  305. <param name="instance">The extensible object to obtain the value from.</param>
  306. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  307. <returns>The effective value of the field, or the default value if not found.</returns>
  308. </member>
  309. <member name="M:ProtoBuf.Extensible.GetValue``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat)">
  310. <summary>
  311. Queries an extensible object for an additional (unexpected) data-field for the instance.
  312. The value returned is the composed value after merging any duplicated content; if the
  313. value is "repeated" (a list), then use GetValues instead.
  314. </summary>
  315. <typeparam name="TValue">The data-type of the field.</typeparam>
  316. <param name="instance">The extensible object to obtain the value from.</param>
  317. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  318. <param name="format">The data-format to use when decoding the value.</param>
  319. <returns>The effective value of the field, or the default value if not found.</returns>
  320. </member>
  321. <member name="M:ProtoBuf.Extensible.TryGetValue``1(ProtoBuf.IExtensible,System.Int32,``0@)">
  322. <summary>
  323. Queries an extensible object for an additional (unexpected) data-field for the instance.
  324. The value returned (in "value") is the composed value after merging any duplicated content;
  325. if the value is "repeated" (a list), then use GetValues instead.
  326. </summary>
  327. <typeparam name="TValue">The data-type of the field.</typeparam>
  328. <param name="value">The effective value of the field, or the default value if not found.</param>
  329. <param name="instance">The extensible object to obtain the value from.</param>
  330. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  331. <returns>True if data for the field was present, false otherwise.</returns>
  332. </member>
  333. <member name="M:ProtoBuf.Extensible.TryGetValue``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,``0@)">
  334. <summary>
  335. Queries an extensible object for an additional (unexpected) data-field for the instance.
  336. The value returned (in "value") is the composed value after merging any duplicated content;
  337. if the value is "repeated" (a list), then use GetValues instead.
  338. </summary>
  339. <typeparam name="TValue">The data-type of the field.</typeparam>
  340. <param name="value">The effective value of the field, or the default value if not found.</param>
  341. <param name="instance">The extensible object to obtain the value from.</param>
  342. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  343. <param name="format">The data-format to use when decoding the value.</param>
  344. <returns>True if data for the field was present, false otherwise.</returns>
  345. </member>
  346. <member name="M:ProtoBuf.Extensible.TryGetValue``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,System.Boolean,``0@)">
  347. <summary>
  348. Queries an extensible object for an additional (unexpected) data-field for the instance.
  349. The value returned (in "value") is the composed value after merging any duplicated content;
  350. if the value is "repeated" (a list), then use GetValues instead.
  351. </summary>
  352. <typeparam name="TValue">The data-type of the field.</typeparam>
  353. <param name="value">The effective value of the field, or the default value if not found.</param>
  354. <param name="instance">The extensible object to obtain the value from.</param>
  355. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  356. <param name="format">The data-format to use when decoding the value.</param>
  357. <param name="allowDefinedTag">Allow tags that are present as part of the definition; for example, to query unknown enum values.</param>
  358. <returns>True if data for the field was present, false otherwise.</returns>
  359. </member>
  360. <member name="M:ProtoBuf.Extensible.GetValues``1(ProtoBuf.IExtensible,System.Int32)">
  361. <summary>
  362. Queries an extensible object for an additional (unexpected) data-field for the instance.
  363. Each occurrence of the field is yielded separately, making this usage suitable for "repeated"
  364. (list) fields.
  365. </summary>
  366. <remarks>The extended data is processed lazily as the enumerator is iterated.</remarks>
  367. <typeparam name="TValue">The data-type of the field.</typeparam>
  368. <param name="instance">The extensible object to obtain the value from.</param>
  369. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  370. <returns>An enumerator that yields each occurrence of the field.</returns>
  371. </member>
  372. <member name="M:ProtoBuf.Extensible.GetValues``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat)">
  373. <summary>
  374. Queries an extensible object for an additional (unexpected) data-field for the instance.
  375. Each occurrence of the field is yielded separately, making this usage suitable for "repeated"
  376. (list) fields.
  377. </summary>
  378. <remarks>The extended data is processed lazily as the enumerator is iterated.</remarks>
  379. <typeparam name="TValue">The data-type of the field.</typeparam>
  380. <param name="instance">The extensible object to obtain the value from.</param>
  381. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  382. <param name="format">The data-format to use when decoding the value.</param>
  383. <returns>An enumerator that yields each occurrence of the field.</returns>
  384. </member>
  385. <member name="M:ProtoBuf.Extensible.TryGetValue(ProtoBuf.Meta.TypeModel,System.Type,ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,System.Boolean,System.Object@)">
  386. <summary>
  387. Queries an extensible object for an additional (unexpected) data-field for the instance.
  388. The value returned (in "value") is the composed value after merging any duplicated content;
  389. if the value is "repeated" (a list), then use GetValues instead.
  390. </summary>
  391. <param name="type">The data-type of the field.</param>
  392. <param name="model">The model to use for configuration.</param>
  393. <param name="value">The effective value of the field, or the default value if not found.</param>
  394. <param name="instance">The extensible object to obtain the value from.</param>
  395. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  396. <param name="format">The data-format to use when decoding the value.</param>
  397. <param name="allowDefinedTag">Allow tags that are present as part of the definition; for example, to query unknown enum values.</param>
  398. <returns>True if data for the field was present, false otherwise.</returns>
  399. </member>
  400. <member name="M:ProtoBuf.Extensible.GetValues(ProtoBuf.Meta.TypeModel,System.Type,ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat)">
  401. <summary>
  402. Queries an extensible object for an additional (unexpected) data-field for the instance.
  403. Each occurrence of the field is yielded separately, making this usage suitable for "repeated"
  404. (list) fields.
  405. </summary>
  406. <remarks>The extended data is processed lazily as the enumerator is iterated.</remarks>
  407. <param name="model">The model to use for configuration.</param>
  408. <param name="type">The data-type of the field.</param>
  409. <param name="instance">The extensible object to obtain the value from.</param>
  410. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  411. <param name="format">The data-format to use when decoding the value.</param>
  412. <returns>An enumerator that yields each occurrence of the field.</returns>
  413. </member>
  414. <member name="M:ProtoBuf.Extensible.AppendValue(ProtoBuf.Meta.TypeModel,ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,System.Object)">
  415. <summary>
  416. Appends the value as an additional (unexpected) data-field for the instance.
  417. Note that for non-repeated sub-objects, this equates to a merge operation;
  418. for repeated sub-objects this adds a new instance to the set; for simple
  419. values the new value supercedes the old value.
  420. </summary>
  421. <remarks>Note that appending a value does not remove the old value from
  422. the stream; avoid repeatedly appending values for the same field.</remarks>
  423. <param name="model">The model to use for configuration.</param>
  424. <param name="format">The data-format to use when encoding the value.</param>
  425. <param name="instance">The extensible object to append the value to.</param>
  426. <param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
  427. <param name="value">The value to append.</param>
  428. </member>
  429. <member name="T:ProtoBuf.ExtensibleUtil">
  430. <summary>
  431. This class acts as an internal wrapper allowing us to do a dynamic
  432. methodinfo invoke; an't put into Serializer as don't want on public
  433. API; can't put into Serializer&lt;T&gt; since we need to invoke
  434. accross classes, which isn't allowed in Silverlight)
  435. </summary>
  436. </member>
  437. <member name="M:ProtoBuf.ExtensibleUtil.GetExtendedValues``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,System.Boolean,System.Boolean)">
  438. <summary>
  439. All this does is call GetExtendedValuesTyped with the correct type for "instance";
  440. this ensures that we don't get issues with subclasses declaring conflicting types -
  441. the caller must respect the fields defined for the type they pass in.
  442. </summary>
  443. </member>
  444. <member name="M:ProtoBuf.ExtensibleUtil.GetExtendedValues(ProtoBuf.Meta.TypeModel,System.Type,ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,System.Boolean,System.Boolean)">
  445. <summary>
  446. All this does is call GetExtendedValuesTyped with the correct type for "instance";
  447. this ensures that we don't get issues with subclasses declaring conflicting types -
  448. the caller must respect the fields defined for the type they pass in.
  449. </summary>
  450. </member>
  451. <member name="M:ProtoBuf.ExtensibleUtil.AppendExtendValueTyped``2(ProtoBuf.Meta.TypeModel,``0,System.Int32,ProtoBuf.DataFormat,``1)">
  452. <summary>
  453. Stores the given value into the instance's stream; the serializer
  454. is inferred from TValue and format.
  455. </summary>
  456. <remarks>Needs to be public to be callable thru reflection in Silverlight</remarks>
  457. </member>
  458. <member name="T:ProtoBuf.Helpers">
  459. <summary>
  460. Not all frameworks are created equal (fx1.1 vs fx2.0,
  461. micro-framework, compact-framework,
  462. silverlight, etc). This class simply wraps up a few things that would
  463. otherwise make the real code unnecessarily messy, providing fallback
  464. implementations if necessary.
  465. </summary>
  466. </member>
  467. <member name="T:ProtoBuf.ProtoTypeCode">
  468. <summary>
  469. Intended to be a direct map to regular TypeCode, but:
  470. - with missing types
  471. - existing on WinRT
  472. </summary>
  473. </member>
  474. <member name="T:ProtoBuf.ImplicitFields">
  475. <summary>
  476. Specifies the method used to infer field tags for members of the type
  477. under consideration. Tags are deduced using the invariant alphabetic
  478. sequence of the members' names; this makes implicit field tags very brittle,
  479. and susceptible to changes such as field names (normally an isolated
  480. change).
  481. </summary>
  482. </member>
  483. <member name="F:ProtoBuf.ImplicitFields.None">
  484. <summary>
  485. No members are serialized implicitly; all members require a suitable
  486. attribute such as [ProtoMember]. This is the recmomended mode for
  487. most scenarios.
  488. </summary>
  489. </member>
  490. <member name="F:ProtoBuf.ImplicitFields.AllPublic">
  491. <summary>
  492. Public properties and fields are eligible for implicit serialization;
  493. this treats the public API as a contract. Ordering beings from ImplicitFirstTag.
  494. </summary>
  495. </member>
  496. <member name="F:ProtoBuf.ImplicitFields.AllFields">
  497. <summary>
  498. Public and non-public fields are eligible for implicit serialization;
  499. this acts as a state/implementation serializer. Ordering beings from ImplicitFirstTag.
  500. </summary>
  501. </member>
  502. <member name="T:ProtoBuf.Meta.CallbackSet">
  503. <summary>
  504. Represents the set of serialization callbacks to be used when serializing/deserializing a type.
  505. </summary>
  506. </member>
  507. <member name="P:ProtoBuf.Meta.CallbackSet.BeforeSerialize">
  508. <summary>Called before serializing an instance</summary>
  509. </member>
  510. <member name="P:ProtoBuf.Meta.CallbackSet.BeforeDeserialize">
  511. <summary>Called before deserializing an instance</summary>
  512. </member>
  513. <member name="P:ProtoBuf.Meta.CallbackSet.AfterSerialize">
  514. <summary>Called after serializing an instance</summary>
  515. </member>
  516. <member name="P:ProtoBuf.Meta.CallbackSet.AfterDeserialize">
  517. <summary>Called after deserializing an instance</summary>
  518. </member>
  519. <member name="P:ProtoBuf.Meta.CallbackSet.NonTrivial">
  520. <summary>
  521. True if any callback is set, else False
  522. </summary>
  523. </member>
  524. <member name="T:ProtoBuf.Meta.MetaType">
  525. <summary>
  526. Represents a type at runtime for use with protobuf, allowing the field mappings (etc) to be defined
  527. </summary>
  528. </member>
  529. <member name="M:ProtoBuf.Meta.MetaType.ToString">
  530. <summary>
  531. Get the name of the type being represented
  532. </summary>
  533. </member>
  534. <member name="M:ProtoBuf.Meta.MetaType.AddSubType(System.Int32,System.Type)">
  535. <summary>
  536. Adds a known sub-type to the inheritance model
  537. </summary>
  538. </member>
  539. <member name="M:ProtoBuf.Meta.MetaType.AddSubType(System.Int32,System.Type,ProtoBuf.DataFormat)">
  540. <summary>
  541. Adds a known sub-type to the inheritance model
  542. </summary>
  543. </member>
  544. <member name="M:ProtoBuf.Meta.MetaType.SetCallbacks(System.Reflection.MethodInfo,System.Reflection.MethodInfo,System.Reflection.MethodInfo,System.Reflection.MethodInfo)">
  545. <summary>
  546. Assigns the callbacks to use during serialiation/deserialization.
  547. </summary>
  548. <param name="beforeSerialize">The method (or null) called before serialization begins.</param>
  549. <param name="afterSerialize">The method (or null) called when serialization is complete.</param>
  550. <param name="beforeDeserialize">The method (or null) called before deserialization begins (or when a new instance is created during deserialization).</param>
  551. <param name="afterDeserialize">The method (or null) called when deserialization is complete.</param>
  552. <returns>The set of callbacks.</returns>
  553. </member>
  554. <member name="M:ProtoBuf.Meta.MetaType.SetCallbacks(System.String,System.String,System.String,System.String)">
  555. <summary>
  556. Assigns the callbacks to use during serialiation/deserialization.
  557. </summary>
  558. <param name="beforeSerialize">The name of the method (or null) called before serialization begins.</param>
  559. <param name="afterSerialize">The name of the method (or null) called when serialization is complete.</param>
  560. <param name="beforeDeserialize">The name of the method (or null) called before deserialization begins (or when a new instance is created during deserialization).</param>
  561. <param name="afterDeserialize">The name of the method (or null) called when deserialization is complete.</param>
  562. <returns>The set of callbacks.</returns>
  563. </member>
  564. <member name="M:ProtoBuf.Meta.MetaType.SetFactory(System.Reflection.MethodInfo)">
  565. <summary>
  566. Designate a factory-method to use to create instances of this type
  567. </summary>
  568. </member>
  569. <member name="M:ProtoBuf.Meta.MetaType.SetFactory(System.String)">
  570. <summary>
  571. Designate a factory-method to use to create instances of this type
  572. </summary>
  573. </member>
  574. <member name="M:ProtoBuf.Meta.MetaType.ThrowIfFrozen">
  575. <summary>
  576. Throws an exception if the type has been made immutable
  577. </summary>
  578. </member>
  579. <member name="M:ProtoBuf.Meta.MetaType.Add(System.Int32,System.String)">
  580. <summary>
  581. Adds a member (by name) to the MetaType
  582. </summary>
  583. </member>
  584. <member name="M:ProtoBuf.Meta.MetaType.AddField(System.Int32,System.String)">
  585. <summary>
  586. Adds a member (by name) to the MetaType, returning the ValueMember rather than the fluent API.
  587. This is otherwise identical to Add.
  588. </summary>
  589. </member>
  590. <member name="M:ProtoBuf.Meta.MetaType.Add(System.String)">
  591. <summary>
  592. Adds a member (by name) to the MetaType
  593. </summary>
  594. </member>
  595. <member name="M:ProtoBuf.Meta.MetaType.SetSurrogate(System.Type)">
  596. <summary>
  597. Performs serialization of this type via a surrogate; all
  598. other serialization options are ignored and handled
  599. by the surrogate's configuration.
  600. </summary>
  601. </member>
  602. <member name="M:ProtoBuf.Meta.MetaType.Add(System.String[])">
  603. <summary>
  604. Adds a set of members (by name) to the MetaType
  605. </summary>
  606. </member>
  607. <member name="M:ProtoBuf.Meta.MetaType.Add(System.Int32,System.String,System.Object)">
  608. <summary>
  609. Adds a member (by name) to the MetaType
  610. </summary>
  611. </member>
  612. <member name="M:ProtoBuf.Meta.MetaType.Add(System.Int32,System.String,System.Type,System.Type)">
  613. <summary>
  614. Adds a member (by name) to the MetaType, including an itemType and defaultType for representing lists
  615. </summary>
  616. </member>
  617. <member name="M:ProtoBuf.Meta.MetaType.AddField(System.Int32,System.String,System.Type,System.Type)">
  618. <summary>
  619. Adds a member (by name) to the MetaType, including an itemType and defaultType for representing lists, returning the ValueMember rather than the fluent API.
  620. This is otherwise identical to Add.
  621. </summary>
  622. </member>
  623. <member name="M:ProtoBuf.Meta.MetaType.GetFields">
  624. <summary>
  625. Returns the ValueMember instances associated with this type
  626. </summary>
  627. </member>
  628. <member name="M:ProtoBuf.Meta.MetaType.GetSubtypes">
  629. <summary>
  630. Returns the SubType instances associated with this type
  631. </summary>
  632. </member>
  633. <member name="M:ProtoBuf.Meta.MetaType.CompileInPlace">
  634. <summary>
  635. Compiles the serializer for this type; this is *not* a full
  636. standalone compile, but can significantly boost performance
  637. while allowing additional types to be added.
  638. </summary>
  639. <remarks>An in-place compile can access non-public types / members</remarks>
  640. </member>
  641. <member name="P:ProtoBuf.Meta.MetaType.BaseType">
  642. <summary>
  643. Gets the base-type for this type
  644. </summary>
  645. </member>
  646. <member name="P:ProtoBuf.Meta.MetaType.IncludeSerializerMethod">
  647. <summary>
  648. When used to compile a model, should public serialization/deserialzation methods
  649. be included for this type?
  650. </summary>
  651. </member>
  652. <member name="P:ProtoBuf.Meta.MetaType.AsReferenceDefault">
  653. <summary>
  654. Should this type be treated as a reference by default?
  655. </summary>
  656. </member>
  657. <member name="P:ProtoBuf.Meta.MetaType.HasCallbacks">
  658. <summary>
  659. Indicates whether the current type has defined callbacks
  660. </summary>
  661. </member>
  662. <member name="P:ProtoBuf.Meta.MetaType.HasSubtypes">
  663. <summary>
  664. Indicates whether the current type has defined subtypes
  665. </summary>
  666. </member>
  667. <member name="P:ProtoBuf.Meta.MetaType.Callbacks">
  668. <summary>
  669. Returns the set of callbacks defined for this type
  670. </summary>
  671. </member>
  672. <member name="P:ProtoBuf.Meta.MetaType.Name">
  673. <summary>
  674. Gets or sets the name of this contract.
  675. </summary>
  676. </member>
  677. <member name="P:ProtoBuf.Meta.MetaType.Type">
  678. <summary>
  679. The runtime type that the meta-type represents
  680. </summary>
  681. </member>
  682. <member name="P:ProtoBuf.Meta.MetaType.UseConstructor">
  683. <summary>
  684. Gets or sets whether the type should use a parameterless constructor (the default),
  685. or whether the type should skip the constructor completely. This option is not supported
  686. on compact-framework.
  687. </summary>
  688. </member>
  689. <member name="P:ProtoBuf.Meta.MetaType.ConstructType">
  690. <summary>
  691. The concrete type to create when a new instance of this type is needed; this may be useful when dealing
  692. with dynamic proxies, or with interface-based APIs
  693. </summary>
  694. </member>
  695. <member name="P:ProtoBuf.Meta.MetaType.Item(System.Int32)">
  696. <summary>
  697. Returns the ValueMember that matchs a given field number, or null if not found
  698. </summary>
  699. </member>
  700. <member name="P:ProtoBuf.Meta.MetaType.Item(System.Reflection.MemberInfo)">
  701. <summary>
  702. Returns the ValueMember that matchs a given member (property/field), or null if not found
  703. </summary>
  704. </member>
  705. <member name="P:ProtoBuf.Meta.MetaType.EnumPassthru">
  706. <summary>
  707. Gets or sets a value indicating that an enum should be treated directly as an int/short/etc, rather
  708. than enforcing .proto enum rules. This is useful *in particul* for [Flags] enums.
  709. </summary>
  710. </member>
  711. <member name="P:ProtoBuf.Meta.MetaType.IgnoreListHandling">
  712. <summary>
  713. Gets or sets a value indicating that this type should NOT be treated as a list, even if it has
  714. familiar list-like characteristics (enumerable, add, etc)
  715. </summary>
  716. </member>
  717. <member name="T:ProtoBuf.Meta.RuntimeTypeModel">
  718. <summary>
  719. Provides protobuf serialization support for a number of types that can be defined at runtime
  720. </summary>
  721. </member>
  722. <member name="T:ProtoBuf.Meta.TypeModel">
  723. <summary>
  724. Provides protobuf serialization support for a number of types
  725. </summary>
  726. </member>
  727. <member name="M:ProtoBuf.Meta.TypeModel.MapType(System.Type)">
  728. <summary>
  729. Resolve a System.Type to the compiler-specific type
  730. </summary>
  731. </member>
  732. <member name="M:ProtoBuf.Meta.TypeModel.MapType(System.Type,System.Boolean)">
  733. <summary>
  734. Resolve a System.Type to the compiler-specific type
  735. </summary>
  736. </member>
  737. <member name="M:ProtoBuf.Meta.TypeModel.TrySerializeAuxiliaryType(ProtoBuf.ProtoWriter,System.Type,ProtoBuf.DataFormat,System.Int32,System.Object,System.Boolean)">
  738. <summary>
  739. This is the more "complete" version of Serialize, which handles single instances of mapped types.
  740. The value is written as a complete field, including field-header and (for sub-objects) a
  741. length-prefix
  742. In addition to that, this provides support for:
  743. - basic values; individual int / string / Guid / etc
  744. - IEnumerable sequences of any type handled by TrySerializeAuxiliaryType
  745. </summary>
  746. </member>
  747. <member name="M:ProtoBuf.Meta.TypeModel.Serialize(System.IO.Stream,System.Object)">
  748. <summary>
  749. Writes a protocol-buffer representation of the given instance to the supplied stream.
  750. </summary>
  751. <param name="value">The existing instance to be serialized (cannot be null).</param>
  752. <param name="dest">The destination stream to write to.</param>
  753. </member>
  754. <member name="M:ProtoBuf.Meta.TypeModel.Serialize(System.IO.Stream,System.Object,ProtoBuf.SerializationContext)">
  755. <summary>
  756. Writes a protocol-buffer representation of the given instance to the supplied stream.
  757. </summary>
  758. <param name="value">The existing instance to be serialized (cannot be null).</param>
  759. <param name="dest">The destination stream to write to.</param>
  760. <param name="context">Additional information about this serialization operation.</param>
  761. </member>
  762. <member name="M:ProtoBuf.Meta.TypeModel.Serialize(ProtoBuf.ProtoWriter,System.Object)">
  763. <summary>
  764. Writes a protocol-buffer representation of the given instance to the supplied writer.
  765. </summary>
  766. <param name="value">The existing instance to be serialized (cannot be null).</param>
  767. <param name="dest">The destination writer to write to.</param>
  768. </member>
  769. <member name="M:ProtoBuf.Meta.TypeModel.DeserializeWithLengthPrefix(System.IO.Stream,System.Object,System.Type,ProtoBuf.PrefixStyle,System.Int32)">
  770. <summary>
  771. Applies a protocol-buffer stream to an existing instance (or null), using length-prefixed
  772. data - useful with network IO.
  773. </summary>
  774. <param name="type">The type being merged.</param>
  775. <param name="value">The existing instance to be modified (can be null).</param>
  776. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  777. <param name="style">How to encode the length prefix.</param>
  778. <param name="fieldNumber">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
  779. <returns>The updated instance; this may be different to the instance argument if
  780. either the original instance was null, or the stream defines a known sub-type of the
  781. original instance.</returns>
  782. </member>
  783. <member name="M:ProtoBuf.Meta.TypeModel.DeserializeWithLengthPrefix(System.IO.Stream,System.Object,System.Type,ProtoBuf.PrefixStyle,System.Int32,ProtoBuf.Serializer.TypeResolver)">
  784. <summary>
  785. Applies a protocol-buffer stream to an existing instance (or null), using length-prefixed
  786. data - useful with network IO.
  787. </summary>
  788. <param name="type">The type being merged.</param>
  789. <param name="value">The existing instance to be modified (can be null).</param>
  790. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  791. <param name="style">How to encode the length prefix.</param>
  792. <param name="expectedField">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
  793. <param name="resolver">Used to resolve types on a per-field basis.</param>
  794. <returns>The updated instance; this may be different to the instance argument if
  795. either the original instance was null, or the stream defines a known sub-type of the
  796. original instance.</returns>
  797. </member>
  798. <member name="M:ProtoBuf.Meta.TypeModel.DeserializeWithLengthPrefix(System.IO.Stream,System.Object,System.Type,ProtoBuf.PrefixStyle,System.Int32,ProtoBuf.Serializer.TypeResolver,System.Int32@)">
  799. <summary>
  800. Applies a protocol-buffer stream to an existing instance (or null), using length-prefixed
  801. data - useful with network IO.
  802. </summary>
  803. <param name="type">The type being merged.</param>
  804. <param name="value">The existing instance to be modified (can be null).</param>
  805. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  806. <param name="style">How to encode the length prefix.</param>
  807. <param name="expectedField">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
  808. <param name="resolver">Used to resolve types on a per-field basis.</param>
  809. <param name="bytesRead">Returns the number of bytes consumed by this operation (includes length-prefix overheads and any skipped data).</param>
  810. <returns>The updated instance; this may be different to the instance argument if
  811. either the original instance was null, or the stream defines a known sub-type of the
  812. original instance.</returns>
  813. </member>
  814. <member name="M:ProtoBuf.Meta.TypeModel.DeserializeItems(System.IO.Stream,System.Type,ProtoBuf.PrefixStyle,System.Int32,ProtoBuf.Serializer.TypeResolver)">
  815. <summary>
  816. Reads a sequence of consecutive length-prefixed items from a stream, using
  817. either base-128 or fixed-length prefixes. Base-128 prefixes with a tag
  818. are directly comparable to serializing multiple items in succession
  819. (use the <see cref="F:ProtoBuf.Serializer.ListItemTag"/> tag to emulate the implicit behavior
  820. when serializing a list/array). When a tag is
  821. specified, any records with different tags are silently omitted. The
  822. tag is ignored. The tag is ignores for fixed-length prefixes.
  823. </summary>
  824. <param name="source">The binary stream containing the serialized records.</param>
  825. <param name="style">The prefix style used in the data.</param>
  826. <param name="expectedField">The tag of records to return (if non-positive, then no tag is
  827. expected and all records are returned).</param>
  828. <param name="resolver">On a field-by-field basis, the type of object to deserialize (can be null if "type" is specified). </param>
  829. <param name="type">The type of object to deserialize (can be null if "resolver" is specified).</param>
  830. <returns>The sequence of deserialized objects.</returns>
  831. </member>
  832. <member name="M:ProtoBuf.Meta.TypeModel.DeserializeItems(System.IO.Stream,System.Type,ProtoBuf.PrefixStyle,System.Int32,ProtoBuf.Serializer.TypeResolver,ProtoBuf.SerializationContext)">
  833. <summary>
  834. Reads a sequence of consecutive length-prefixed items from a stream, using
  835. either base-128 or fixed-length prefixes. Base-128 prefixes with a tag
  836. are directly comparable to serializing multiple items in succession
  837. (use the <see cref="F:ProtoBuf.Serializer.ListItemTag"/> tag to emulate the implicit behavior
  838. when serializing a list/array). When a tag is
  839. specified, any records with different tags are silently omitted. The
  840. tag is ignored. The tag is ignores for fixed-length prefixes.
  841. </summary>
  842. <param name="source">The binary stream containing the serialized records.</param>
  843. <param name="style">The prefix style used in the data.</param>
  844. <param name="expectedField">The tag of records to return (if non-positive, then no tag is
  845. expected and all records are returned).</param>
  846. <param name="resolver">On a field-by-field basis, the type of object to deserialize (can be null if "type" is specified). </param>
  847. <param name="type">The type of object to deserialize (can be null if "resolver" is specified).</param>
  848. <returns>The sequence of deserialized objects.</returns>
  849. <param name="context">Additional information about this serialization operation.</param>
  850. </member>
  851. <member name="M:ProtoBuf.Meta.TypeModel.DeserializeItems``1(System.IO.Stream,ProtoBuf.PrefixStyle,System.Int32)">
  852. <summary>
  853. Reads a sequence of consecutive length-prefixed items from a stream, using
  854. either base-128 or fixed-length prefixes. Base-128 prefixes with a tag
  855. are directly comparable to serializing multiple items in succession
  856. (use the <see cref="F:ProtoBuf.Serializer.ListItemTag"/> tag to emulate the implicit behavior
  857. when serializing a list/array). When a tag is
  858. specified, any records with different tags are silently omitted. The
  859. tag is ignored. The tag is ignores for fixed-length prefixes.
  860. </summary>
  861. <typeparam name="T">The type of object to deserialize.</typeparam>
  862. <param name="source">The binary stream containing the serialized records.</param>
  863. <param name="style">The prefix style used in the data.</param>
  864. <param name="expectedField">The tag of records to return (if non-positive, then no tag is
  865. expected and all records are returned).</param>
  866. <returns>The sequence of deserialized objects.</returns>
  867. </member>
  868. <member name="M:ProtoBuf.Meta.TypeModel.DeserializeItems``1(System.IO.Stream,ProtoBuf.PrefixStyle,System.Int32,ProtoBuf.SerializationContext)">
  869. <summary>
  870. Reads a sequence of consecutive length-prefixed items from a stream, using
  871. either base-128 or fixed-length prefixes. Base-128 prefixes with a tag
  872. are directly comparable to serializing multiple items in succession
  873. (use the <see cref="F:ProtoBuf.Serializer.ListItemTag"/> tag to emulate the implicit behavior
  874. when serializing a list/array). When a tag is
  875. specified, any records with different tags are silently omitted. The
  876. tag is ignored. The tag is ignores for fixed-length prefixes.
  877. </summary>
  878. <typeparam name="T">The type of object to deserialize.</typeparam>
  879. <param name="source">The binary stream containing the serialized records.</param>
  880. <param name="style">The prefix style used in the data.</param>
  881. <param name="expectedField">The tag of records to return (if non-positive, then no tag is
  882. expected and all records are returned).</param>
  883. <returns>The sequence of deserialized objects.</returns>
  884. <param name="context">Additional information about this serialization operation.</param>
  885. </member>
  886. <member name="M:ProtoBuf.Meta.TypeModel.SerializeWithLengthPrefix(System.IO.Stream,System.Object,System.Type,ProtoBuf.PrefixStyle,System.Int32)">
  887. <summary>
  888. Writes a protocol-buffer representation of the given instance to the supplied stream,
  889. with a length-prefix. This is useful for socket programming,
  890. as DeserializeWithLengthPrefix can be used to read the single object back
  891. from an ongoing stream.
  892. </summary>
  893. <param name="type">The type being serialized.</param>
  894. <param name="value">The existing instance to be serialized (cannot be null).</param>
  895. <param name="style">How to encode the length prefix.</param>
  896. <param name="dest">The destination stream to write to.</param>
  897. <param name="fieldNumber">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
  898. </member>
  899. <member name="M:ProtoBuf.Meta.TypeModel.SerializeWithLengthPrefix(System.IO.Stream,System.Object,System.Type,ProtoBuf.PrefixStyle,System.Int32,ProtoBuf.SerializationContext)">
  900. <summary>
  901. Writes a protocol-buffer representation of the given instance to the supplied stream,
  902. with a length-prefix. This is useful for socket programming,
  903. as DeserializeWithLengthPrefix can be used to read the single object back
  904. from an ongoing stream.
  905. </summary>
  906. <param name="type">The type being serialized.</param>
  907. <param name="value">The existing instance to be serialized (cannot be null).</param>
  908. <param name="style">How to encode the length prefix.</param>
  909. <param name="dest">The destination stream to write to.</param>
  910. <param name="fieldNumber">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
  911. <param name="context">Additional information about this serialization operation.</param>
  912. </member>
  913. <member name="M:ProtoBuf.Meta.TypeModel.Deserialize(System.IO.Stream,System.Object,System.Type)">
  914. <summary>
  915. Applies a protocol-buffer stream to an existing instance (which may be null).
  916. </summary>
  917. <param name="type">The type (including inheritance) to consider.</param>
  918. <param name="value">The existing instance to be modified (can be null).</param>
  919. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  920. <returns>The updated instance; this may be different to the instance argument if
  921. either the original instance was null, or the stream defines a known sub-type of the
  922. original instance.</returns>
  923. </member>
  924. <member name="M:ProtoBuf.Meta.TypeModel.Deserialize(System.IO.Stream,System.Object,System.Type,ProtoBuf.SerializationContext)">
  925. <summary>
  926. Applies a protocol-buffer stream to an existing instance (which may be null).
  927. </summary>
  928. <param name="type">The type (including inheritance) to consider.</param>
  929. <param name="value">The existing instance to be modified (can be null).</param>
  930. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  931. <returns>The updated instance; this may be different to the instance argument if
  932. either the original instance was null, or the stream defines a known sub-type of the
  933. original instance.</returns>
  934. <param name="context">Additional information about this serialization operation.</param>
  935. </member>
  936. <member name="M:ProtoBuf.Meta.TypeModel.Deserialize(System.IO.Stream,System.Object,System.Type,System.Int32)">
  937. <summary>
  938. Applies a protocol-buffer stream to an existing instance (which may be null).
  939. </summary>
  940. <param name="type">The type (including inheritance) to consider.</param>
  941. <param name="value">The existing instance to be modified (can be null).</param>
  942. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  943. <param name="length">The number of bytes to consume.</param>
  944. <returns>The updated instance; this may be different to the instance argument if
  945. either the original instance was null, or the stream defines a known sub-type of the
  946. original instance.</returns>
  947. </member>
  948. <member name="M:ProtoBuf.Meta.TypeModel.Deserialize(System.IO.Stream,System.Object,System.Type,System.Int32,ProtoBuf.SerializationContext)">
  949. <summary>
  950. Applies a protocol-buffer stream to an existing instance (which may be null).
  951. </summary>
  952. <param name="type">The type (including inheritance) to consider.</param>
  953. <param name="value">The existing instance to be modified (can be null).</param>
  954. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  955. <param name="length">The number of bytes to consume (or -1 to read to the end of the stream).</param>
  956. <returns>The updated instance; this may be different to the instance argument if
  957. either the original instance was null, or the stream defines a known sub-type of the
  958. original instance.</returns>
  959. <param name="context">Additional information about this serialization operation.</param>
  960. </member>
  961. <member name="M:ProtoBuf.Meta.TypeModel.Deserialize(ProtoBuf.ProtoReader,System.Object,System.Type)">
  962. <summary>
  963. Applies a protocol-buffer reader to an existing instance (which may be null).
  964. </summary>
  965. <param name="type">The type (including inheritance) to consider.</param>
  966. <param name="value">The existing instance to be modified (can be null).</param>
  967. <param name="source">The reader to apply to the instance (cannot be null).</param>
  968. <returns>The updated instance; this may be different to the instance argument if
  969. either the original instance was null, or the stream defines a known sub-type of the
  970. original instance.</returns>
  971. </member>
  972. <member name="M:ProtoBuf.Meta.TypeModel.TryDeserializeAuxiliaryType(ProtoBuf.ProtoReader,ProtoBuf.DataFormat,System.Int32,System.Type,System.Object@,System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
  973. <summary>
  974. This is the more "complete" version of Deserialize, which handles single instances of mapped types.
  975. The value is read as a complete field, including field-header and (for sub-objects) a
  976. length-prefix..kmc
  977. In addition to that, this provides support for:
  978. - basic values; individual int / string / Guid / etc
  979. - IList sets of any type handled by TryDeserializeAuxiliaryType
  980. </summary>
  981. </member>
  982. <member name="M:ProtoBuf.Meta.TypeModel.Create">
  983. <summary>
  984. Creates a new runtime model, to which the caller
  985. can add support for a range of types. A model
  986. can be used "as is", or can be compiled for
  987. optimal performance.
  988. </summary>
  989. </member>
  990. <member name="M:ProtoBuf.Meta.TypeModel.ResolveProxies(System.Type)">
  991. <summary>
  992. Applies common proxy scenarios, resolving the actual type to consider
  993. </summary>
  994. </member>
  995. <member name="M:ProtoBuf.Meta.TypeModel.IsDefined(System.Type)">
  996. <summary>
  997. Indicates whether the supplied type is explicitly modelled by the model
  998. </summary>
  999. </member>
  1000. <member name="M:ProtoBuf.Meta.TypeModel.GetKey(System.Type@)">
  1001. <summary>
  1002. Provides the key that represents a given type in the current model.
  1003. The type is also normalized for proxies at the same time.
  1004. </summary>
  1005. </member>
  1006. <member name="M:ProtoBuf.Meta.TypeModel.GetKeyImpl(System.Type)">
  1007. <summary>
  1008. Provides the key that represents a given type in the current model.
  1009. </summary>
  1010. </member>
  1011. <member name="M:ProtoBuf.Meta.TypeModel.Serialize(System.Int32,System.Object,ProtoBuf.ProtoWriter)">
  1012. <summary>
  1013. Writes a protocol-buffer representation of the given instance to the supplied stream.
  1014. </summary>
  1015. <param name="key">Represents the type (including inheritance) to consider.</param>
  1016. <param name="value">The existing instance to be serialized (cannot be null).</param>
  1017. <param name="dest">The destination stream to write to.</param>
  1018. </member>
  1019. <member name="M:ProtoBuf.Meta.TypeModel.Deserialize(System.Int32,System.Object,ProtoBuf.ProtoReader)">
  1020. <summary>
  1021. Applies a protocol-buffer stream to an existing instance (which may be null).
  1022. </summary>
  1023. <param name="key">Represents the type (including inheritance) to consider.</param>
  1024. <param name="value">The existing instance to be modified (can be null).</param>
  1025. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  1026. <returns>The updated instance; this may be different to the instance argument if
  1027. either the original instance was null, or the stream defines a known sub-type of the
  1028. original instance.</returns>
  1029. </member>
  1030. <member name="M:ProtoBuf.Meta.TypeModel.DeepClone(System.Object)">
  1031. <summary>
  1032. Create a deep clone of the supplied instance; any sub-items are also cloned.
  1033. </summary>
  1034. </member>
  1035. <member name="M:ProtoBuf.Meta.TypeModel.ThrowUnexpectedSubtype(System.Type,System.Type)">
  1036. <summary>
  1037. Indicates that while an inheritance tree exists, the exact type encountered was not
  1038. specified in that hierarchy and cannot be processed.
  1039. </summary>
  1040. </member>
  1041. <member name="M:ProtoBuf.Meta.TypeModel.ThrowUnexpectedType(System.Type)">
  1042. <summary>
  1043. Indicates that the given type was not expected, and cannot be processed.
  1044. </summary>
  1045. </member>
  1046. <member name="M:ProtoBuf.Meta.TypeModel.ThrowCannotCreateInstance(System.Type)">
  1047. <summary>
  1048. Indicates that the given type cannot be constructed; it may still be possible to
  1049. deserialize into existing instances.
  1050. </summary>
  1051. </member>
  1052. <member name="M:ProtoBuf.Meta.TypeModel.CanSerializeContractType(System.Type)">
  1053. <summary>
  1054. Returns true if the type supplied is either a recognised contract type,
  1055. or a *list* of a recognised contract type.
  1056. </summary>
  1057. <remarks>Note that primitives always return false, even though the engine
  1058. will, if forced, try to serialize such</remarks>
  1059. <returns>True if this type is recognised as a serializable entity, else false</returns>
  1060. </member>
  1061. <member name="M:ProtoBuf.Meta.TypeModel.CanSerialize(System.Type)">
  1062. <summary>
  1063. Returns true if the type supplied is a basic type with inbuilt handling,
  1064. a recognised contract type, or a *list* of a basic / contract type.
  1065. </summary>
  1066. </member>
  1067. <member name="M:ProtoBuf.Meta.TypeModel.CanSerializeBasicType(System.Type)">
  1068. <summary>
  1069. Returns true if the type supplied is a basic type with inbuilt handling,
  1070. or a *list* of a basic type with inbuilt handling
  1071. </summary>
  1072. </member>
  1073. <member name="M:ProtoBuf.Meta.TypeModel.GetSchema(System.Type)">
  1074. <summary>
  1075. Suggest a .proto definition for the given type
  1076. </summary>
  1077. <param name="type">The type to generate a .proto definition for, or <c>null</c> to generate a .proto that represents the entire model</param>
  1078. <returns>The .proto definition as a string</returns>
  1079. </member>
  1080. <member name="M:ProtoBuf.Meta.TypeModel.CreateFormatter(System.Type)">
  1081. <summary>
  1082. Creates a new IFormatter that uses protocol-buffer [de]serialization.
  1083. </summary>
  1084. <returns>A new IFormatter to be used during [de]serialization.</returns>
  1085. <param name="type">The type of object to be [de]deserialized by the formatter.</param>
  1086. </member>
  1087. <member name="E:ProtoBuf.Meta.TypeModel.DynamicTypeFormatting">
  1088. <summary>
  1089. Used to provide custom services for writing and parsing type names when using dynamic types. Both parsing and formatting
  1090. are provided on a single API as it is essential that both are mapped identically at all times.
  1091. </summary>
  1092. </member>
  1093. <member name="T:ProtoBuf.Meta.TypeModel.CallbackType">
  1094. <summary>
  1095. Indicates the type of callback to be used
  1096. </summary>
  1097. </member>
  1098. <member name="F:ProtoBuf.Meta.TypeModel.CallbackType.BeforeSerialize">
  1099. <summary>
  1100. Invoked before an object is serialized
  1101. </summary>
  1102. </member>
  1103. <member name="F:ProtoBuf.Meta.TypeModel.CallbackType.AfterSerialize">
  1104. <summary>
  1105. Invoked after an object is serialized
  1106. </summary>
  1107. </member>
  1108. <member name="F:ProtoBuf.Meta.TypeModel.CallbackType.BeforeDeserialize">
  1109. <summary>
  1110. Invoked before an object is deserialized (or when a new instance is created)
  1111. </summary>
  1112. </member>
  1113. <member name="F:ProtoBuf.Meta.TypeModel.CallbackType.AfterDeserialize">
  1114. <summary>
  1115. Invoked after an object is deserialized
  1116. </summary>
  1117. </member>
  1118. <member name="M:ProtoBuf.Meta.RuntimeTypeModel.GetTypes">
  1119. <summary>
  1120. Returns a sequence of the Type instances that can be
  1121. processed by this model.
  1122. </summary>
  1123. </member>
  1124. <member name="M:ProtoBuf.Meta.RuntimeTypeModel.GetSchema(System.Type)">
  1125. <summary>
  1126. Suggest a .proto definition for the given type
  1127. </summary>
  1128. <param name="type">The type to generate a .proto definition for, or <c>null</c> to generate a .proto that represents the entire model</param>
  1129. <returns>The .proto definition as a string</returns>
  1130. </member>
  1131. <member name="M:ProtoBuf.Meta.RuntimeTypeModel.Add(System.Type,System.Boolean)">
  1132. <summary>
  1133. Adds support for an additional type in this model, optionally
  1134. appplying inbuilt patterns. If the type is already known to the
  1135. model, the existing type is returned **without** applying
  1136. any additional behaviour.
  1137. </summary>
  1138. <remarks>Inbuilt patterns include:
  1139. [ProtoContract]/[ProtoMember(n)]
  1140. [DataContract]/[DataMember(Order=n)]
  1141. [XmlType]/[XmlElement(Order=n)]
  1142. [On{Des|S}erializ{ing|ed}]
  1143. ShouldSerialize*/*Specified
  1144. </remarks>
  1145. <param name="type">The type to be supported</param>
  1146. <param name="applyDefaultBehaviour">Whether to apply the inbuilt configuration patterns (via attributes etc), or
  1147. just add the type with no additional configuration (the type must then be manually configured).</param>
  1148. <returns>The MetaType representing this type, allowing
  1149. further configuration.</returns>
  1150. </member>
  1151. <member name="M:ProtoBuf.Meta.RuntimeTypeModel.ThrowIfFrozen">
  1152. <summary>
  1153. Verifies that the model is still open to changes; if not, an exception is thrown
  1154. </summary>
  1155. </member>
  1156. <member name="M:ProtoBuf.Meta.RuntimeTypeModel.Freeze">
  1157. <summary>
  1158. Prevents further changes to this model
  1159. </summary>
  1160. </member>
  1161. <member name="M:ProtoBuf.Meta.RuntimeTypeModel.GetKeyImpl(System.Type)">
  1162. <summary>
  1163. Provides the key that represents a given type in the current model.
  1164. </summary>
  1165. </member>
  1166. <member name="M:ProtoBuf.Meta.RuntimeTypeModel.Serialize(System.Int32,System.Object,ProtoBuf.ProtoWriter)">
  1167. <summary>
  1168. Writes a protocol-buffer representation of the given instance to the supplied stream.
  1169. </summary>
  1170. <param name="key">Represents the type (including inheritance) to consider.</param>
  1171. <param name="value">The existing instance to be serialized (cannot be null).</param>
  1172. <param name="dest">The destination stream to write to.</param>
  1173. </member>
  1174. <member name="M:ProtoBuf.Meta.RuntimeTypeModel.Deserialize(System.Int32,System.Object,ProtoBuf.ProtoReader)">
  1175. <summary>
  1176. Applies a protocol-buffer stream to an existing instance (which may be null).
  1177. </summary>
  1178. <param name="key">Represents the type (including inheritance) to consider.</param>
  1179. <param name="value">The existing instance to be modified (can be null).</param>
  1180. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  1181. <returns>The updated instance; this may be different to the instance argument if
  1182. either the original instance was null, or the stream defines a known sub-type of the
  1183. original instance.</returns>
  1184. </member>
  1185. <member name="M:ProtoBuf.Meta.RuntimeTypeModel.CompileInPlace">
  1186. <summary>
  1187. Compiles the serializers individually; this is *not* a full
  1188. standalone compile, but can significantly boost performance
  1189. while allowing additional types to be added.
  1190. </summary>
  1191. <remarks>An in-place compile can access non-public types / members</remarks>
  1192. </member>
  1193. <member name="M:ProtoBuf.Meta.RuntimeTypeModel.Compile">
  1194. <summary>
  1195. Fully compiles the current model into a static-compiled model instance
  1196. </summary>
  1197. <remarks>A full compilation is restricted to accessing public types / members</remarks>
  1198. <returns>An instance of the newly created compiled type-model</returns>
  1199. </member>
  1200. <member name="M:ProtoBuf.Meta.RuntimeTypeModel.Compile(System.String,System.String)">
  1201. <summary>
  1202. Fully compiles the current model into a static-compiled serialization dll
  1203. (the serialization dll still requires protobuf-net for support services).
  1204. </summary>
  1205. <remarks>A full compilation is restricted to accessing public types / members</remarks>
  1206. <param name="name">The name of the TypeModel class to create</param>
  1207. <param name="path">The path for the new dll</param>
  1208. <returns>An instance of the newly created compiled type-model</returns>
  1209. </member>
  1210. <member name="M:ProtoBuf.Meta.RuntimeTypeModel.Compile(ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions)">
  1211. <summary>
  1212. Fully compiles the current model into a static-compiled serialization dll
  1213. (the serialization dll still requires protobuf-net for support services).
  1214. </summary>
  1215. <remarks>A full compilation is restricted to accessing public types / members</remarks>
  1216. <returns>An instance of the newly created compiled type-model</returns>
  1217. </member>
  1218. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.InferTagFromNameDefault">
  1219. <summary>
  1220. Global default that
  1221. enables/disables automatic tag generation based on the existing name / order
  1222. of the defined members. See <seealso cref="P:ProtoBuf.ProtoContractAttribute.InferTagFromName"/>
  1223. for usage and <b>important warning</b> / explanation.
  1224. You must set the global default before attempting to serialize/deserialize any
  1225. impacted type.
  1226. </summary>
  1227. </member>
  1228. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.AutoAddProtoContractTypesOnly">
  1229. <summary>
  1230. Global default that determines whether types are considered serializable
  1231. if they have [DataContract] / [XmlType]. With this enabled, <b>ONLY</b>
  1232. types marked as [ProtoContract] are added automatically.
  1233. </summary>
  1234. </member>
  1235. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.UseImplicitZeroDefaults">
  1236. <summary>
  1237. Global switch that enables or disables the implicit
  1238. handling of "zero defaults"; meanning: if no other default is specified,
  1239. it assumes bools always default to false, integers to zero, etc.
  1240. If this is disabled, no such assumptions are made and only *explicit*
  1241. default values are processed. This is enabled by default to
  1242. preserve similar logic to v1.
  1243. </summary>
  1244. </member>
  1245. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.AllowParseableTypes">
  1246. <summary>
  1247. Global switch that determines whether types with a <c>.ToString()</c> and a <c>Parse(string)</c>
  1248. should be serialized as strings.
  1249. </summary>
  1250. </member>
  1251. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.Default">
  1252. <summary>
  1253. The default model, used to support ProtoBuf.Serializer
  1254. </summary>
  1255. </member>
  1256. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.Item(System.Type)">
  1257. <summary>
  1258. Obtains the MetaType associated with a given Type for the current model,
  1259. allowing additional configuration.
  1260. </summary>
  1261. </member>
  1262. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.AutoCompile">
  1263. <summary>
  1264. Should serializers be compiled on demand? It may be useful
  1265. to disable this for debugging purposes.
  1266. </summary>
  1267. </member>
  1268. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.AutoAddMissingTypes">
  1269. <summary>
  1270. Should support for unexpected types be added automatically?
  1271. If false, an exception is thrown when unexpected types
  1272. are encountered.
  1273. </summary>
  1274. </member>
  1275. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.MetadataTimeoutMilliseconds">
  1276. <summary>
  1277. The amount of time to wait if there are concurrent metadata access operations
  1278. </summary>
  1279. </member>
  1280. <member name="E:ProtoBuf.Meta.RuntimeTypeModel.LockContended">
  1281. <summary>
  1282. If a lock-contention is detected, this event signals the *owner* of the lock responsible for the blockage, indicating
  1283. what caused the problem; this is only raised if the lock-owning code successfully completes.
  1284. </summary>
  1285. </member>
  1286. <member name="T:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions">
  1287. <summary>
  1288. Represents configuration options for compiling a model to
  1289. a standalone assembly.
  1290. </summary>
  1291. </member>
  1292. <member name="M:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.SetFrameworkOptions(ProtoBuf.Meta.MetaType)">
  1293. <summary>
  1294. Import framework options from an existing type
  1295. </summary>
  1296. </member>
  1297. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.TargetFrameworkName">
  1298. <summary>
  1299. The TargetFrameworkAttribute FrameworkName value to burn into the generated assembly
  1300. </summary>
  1301. </member>
  1302. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.TargetFrameworkDisplayName">
  1303. <summary>
  1304. The TargetFrameworkAttribute FrameworkDisplayName value to burn into the generated assembly
  1305. </summary>
  1306. </member>
  1307. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.TypeName">
  1308. <summary>
  1309. The name of the TypeModel class to create
  1310. </summary>
  1311. </member>
  1312. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.OutputPath">
  1313. <summary>
  1314. The path for the new dll
  1315. </summary>
  1316. </member>
  1317. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.ImageRuntimeVersion">
  1318. <summary>
  1319. The runtime version for the generated assembly
  1320. </summary>
  1321. </member>
  1322. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.MetaDataVersion">
  1323. <summary>
  1324. The runtime version for the generated assembly
  1325. </summary>
  1326. </member>
  1327. <member name="P:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.Accessibility">
  1328. <summary>
  1329. The acecssibility of the generated serializer
  1330. </summary>
  1331. </member>
  1332. <member name="T:ProtoBuf.Meta.RuntimeTypeModel.Accessibility">
  1333. <summary>
  1334. Type accessibility
  1335. </summary>
  1336. </member>
  1337. <member name="F:ProtoBuf.Meta.RuntimeTypeModel.Accessibility.Public">
  1338. <summary>
  1339. Available to all callers
  1340. </summary>
  1341. </member>
  1342. <member name="F:ProtoBuf.Meta.RuntimeTypeModel.Accessibility.Internal">
  1343. <summary>
  1344. Available to all callers in the same assembly, or assemblies specified via [InternalsVisibleTo(...)]
  1345. </summary>
  1346. </member>
  1347. <member name="T:ProtoBuf.Meta.LockContentedEventArgs">
  1348. <summary>
  1349. Contains the stack-trace of the owning code when a lock-contention scenario is detected
  1350. </summary>
  1351. </member>
  1352. <member name="P:ProtoBuf.Meta.LockContentedEventArgs.OwnerStackTrace">
  1353. <summary>
  1354. The stack-trace of the code that owned the lock when a lock-contention scenario occurred
  1355. </summary>
  1356. </member>
  1357. <member name="T:ProtoBuf.Meta.LockContentedEventHandler">
  1358. <summary>
  1359. Event-type that is raised when a lock-contention scenario is detected
  1360. </summary>
  1361. </member>
  1362. <member name="T:ProtoBuf.Meta.SubType">
  1363. <summary>
  1364. Represents an inherited type in a type hierarchy.
  1365. </summary>
  1366. </member>
  1367. <member name="M:ProtoBuf.Meta.SubType.#ctor(System.Int32,ProtoBuf.Meta.MetaType,ProtoBuf.DataFormat)">
  1368. <summary>
  1369. Creates a new SubType instance.
  1370. </summary>
  1371. <param name="fieldNumber">The field-number that is used to encapsulate the data (as a nested
  1372. message) for the derived dype.</param>
  1373. <param name="derivedType">The sub-type to be considered.</param>
  1374. <param name="format">Specific encoding style to use; in particular, Grouped can be used to avoid buffering, but is not the default.</param>
  1375. </member>
  1376. <member name="P:ProtoBuf.Meta.SubType.FieldNumber">
  1377. <summary>
  1378. The field-number that is used to encapsulate the data (as a nested
  1379. message) for the derived dype.
  1380. </summary>
  1381. </member>
  1382. <member name="P:ProtoBuf.Meta.SubType.DerivedType">
  1383. <summary>
  1384. The sub-type to be considered.
  1385. </summary>
  1386. </member>
  1387. <member name="T:ProtoBuf.Meta.TypeFormatEventArgs">
  1388. <summary>
  1389. Event arguments needed to perform type-formatting functions; this could be resolving a Type to a string suitable for serialization, or could
  1390. be requesting a Type from a string. If no changes are made, a default implementation will be used (from the assembly-qualified names).
  1391. </summary>
  1392. </member>
  1393. <member name="P:ProtoBuf.Meta.TypeFormatEventArgs.Type">
  1394. <summary>
  1395. The type involved in this map; if this is initially null, a Type is expected to be provided for the string in FormattedName.
  1396. </summary>
  1397. </member>
  1398. <member name="P:ProtoBuf.Meta.TypeFormatEventArgs.FormattedName">
  1399. <summary>
  1400. The formatted-name involved in this map; if this is initially null, a formatted-name is expected from the type in Type.
  1401. </summary>
  1402. </member>
  1403. <member name="T:ProtoBuf.Meta.TypeFormatEventHandler">
  1404. <summary>
  1405. Delegate type used to perform type-formatting functions; the sender originates as the type-model.
  1406. </summary>
  1407. </member>
  1408. <member name="T:ProtoBuf.Meta.ValueMember">
  1409. <summary>
  1410. Represents a member (property/field) that is mapped to a protobuf field
  1411. </summary>
  1412. </member>
  1413. <member name="M:ProtoBuf.Meta.ValueMember.#ctor(ProtoBuf.Meta.RuntimeTypeModel,System.Type,System.Int32,System.Reflection.MemberInfo,System.Type,System.Type,System.Type,ProtoBuf.DataFormat,System.Object)">
  1414. <summary>
  1415. Creates a new ValueMember instance
  1416. </summary>
  1417. </member>
  1418. <member name="M:ProtoBuf.Meta.ValueMember.#ctor(ProtoBuf.Meta.RuntimeTypeModel,System.Int32,System.Type,System.Type,System.Type,ProtoBuf.DataFormat)">
  1419. <summary>
  1420. Creates a new ValueMember instance
  1421. </summary>
  1422. </member>
  1423. <member name="M:ProtoBuf.Meta.ValueMember.SetSpecified(System.Reflection.MethodInfo,System.Reflection.MethodInfo)">
  1424. <summary>
  1425. Specifies methods for working with optional data members.
  1426. </summary>
  1427. <param name="getSpecified">Provides a method (null for none) to query whether this member should
  1428. be serialized; it must be of the form "bool {Method}()". The member is only serialized if the
  1429. method returns true.</param>
  1430. <param name="setSpecified">Provides a method (null for none) to indicate that a member was
  1431. deserialized; it must be of the form "void {Method}(bool)", and will be called with "true"
  1432. when data is found.</param>
  1433. </member>
  1434. <member name="P:ProtoBuf.Meta.ValueMember.FieldNumber">
  1435. <summary>
  1436. The number that identifies this member in a protobuf stream
  1437. </summary>
  1438. </member>
  1439. <member name="P:ProtoBuf.Meta.ValueMember.Member">
  1440. <summary>
  1441. Gets the member (field/property) which this member relates to.
  1442. </summary>
  1443. </member>
  1444. <member name="P:ProtoBuf.Meta.ValueMember.ItemType">
  1445. <summary>
  1446. Within a list / array / etc, the type of object for each item in the list (especially useful with ArrayList)
  1447. </summary>
  1448. </member>
  1449. <member name="P:ProtoBuf.Meta.ValueMember.MemberType">
  1450. <summary>
  1451. The underlying type of the member
  1452. </summary>
  1453. </member>
  1454. <member name="P:ProtoBuf.Meta.ValueMember.DefaultType">
  1455. <summary>
  1456. For abstract types (IList etc), the type of concrete object to create (if required)
  1457. </summary>
  1458. </member>
  1459. <member name="P:ProtoBuf.Meta.ValueMember.ParentType">
  1460. <summary>
  1461. The type the defines the member
  1462. </summary>
  1463. </member>
  1464. <member name="P:ProtoBuf.Meta.ValueMember.DefaultValue">
  1465. <summary>
  1466. The default value of the item (members with this value will not be serialized)
  1467. </summary>
  1468. </member>
  1469. <member name="P:ProtoBuf.Meta.ValueMember.DataFormat">
  1470. <summary>
  1471. Specifies the rules used to process the field; this is used to determine the most appropriate
  1472. wite-type, but also to describe subtypes <i>within</i> that wire-type (such as SignedVariant)
  1473. </summary>
  1474. </member>
  1475. <member name="P:ProtoBuf.Meta.ValueMember.IsStrict">
  1476. <summary>
  1477. Indicates whether this field should follow strict encoding rules; this means (for example) that if a "fixed32"
  1478. is encountered when "variant" is defined, then it will fail (throw an exception) when parsing. Note that
  1479. when serializing the defined type is always used.
  1480. </summary>
  1481. </member>
  1482. <member name="P:ProtoBuf.Meta.ValueMember.IsPacked">
  1483. <summary>
  1484. Indicates whether this field should use packed encoding (which can save lots of space for repeated primitive values).
  1485. This option only applies to list/array data of primitive types (int, double, etc).
  1486. </summary>
  1487. </member>
  1488. <member name="P:ProtoBuf.Meta.ValueMember.OverwriteList">
  1489. <summary>
  1490. Indicates whether this field should *repace* existing values (the default is false, meaning *append*).
  1491. This option only applies to list/array data.
  1492. </summary>
  1493. </member>
  1494. <member name="P:ProtoBuf.Meta.ValueMember.IsRequired">
  1495. <summary>
  1496. Indicates whether this field is mandatory.
  1497. </summary>
  1498. </member>
  1499. <member name="P:ProtoBuf.Meta.ValueMember.AsReference">
  1500. <summary>
  1501. Enables full object-tracking/full-graph support.
  1502. </summary>
  1503. </member>
  1504. <member name="P:ProtoBuf.Meta.ValueMember.DynamicType">
  1505. <summary>
  1506. Embeds the type information into the stream, allowing usage with types not known in advance.
  1507. </summary>
  1508. </member>
  1509. <member name="P:ProtoBuf.Meta.ValueMember.Name">
  1510. <summary>
  1511. Gets the logical name for this member in the schema (this is not critical for binary serialization, but may be used
  1512. when inferring a schema).
  1513. </summary>
  1514. </member>
  1515. <member name="P:ProtoBuf.Meta.ValueMember.SupportNull">
  1516. <summary>
  1517. Should lists have extended support for null values? Note this makes the serialization less efficient.
  1518. </summary>
  1519. </member>
  1520. <member name="T:ProtoBuf.PrefixStyle">
  1521. <summary>
  1522. Specifies the type of prefix that should be applied to messages.
  1523. </summary>
  1524. </member>
  1525. <member name="F:ProtoBuf.PrefixStyle.None">
  1526. <summary>
  1527. No length prefix is applied to the data; the data is terminated only be the end of the stream.
  1528. </summary>
  1529. </member>
  1530. <member name="F:ProtoBuf.PrefixStyle.Base128">
  1531. <summary>
  1532. A base-128 length prefix is applied to the data (efficient for short messages).
  1533. </summary>
  1534. </member>
  1535. <member name="F:ProtoBuf.PrefixStyle.Fixed32">
  1536. <summary>
  1537. A fixed-length (little-endian) length prefix is applied to the data (useful for compatibility).
  1538. </summary>
  1539. </member>
  1540. <member name="F:ProtoBuf.PrefixStyle.Fixed32BigEndian">
  1541. <summary>
  1542. A fixed-length (big-endian) length prefix is applied to the data (useful for compatibility).
  1543. </summary>
  1544. </member>
  1545. <member name="T:ProtoBuf.ProtoContractAttribute">
  1546. <summary>
  1547. Indicates that a type is defined for protocol-buffer serialization.
  1548. </summary>
  1549. </member>
  1550. <member name="P:ProtoBuf.ProtoContractAttribute.Name">
  1551. <summary>
  1552. Gets or sets the defined name of the type.
  1553. </summary>
  1554. </member>
  1555. <member name="P:ProtoBuf.ProtoContractAttribute.ImplicitFirstTag">
  1556. <summary>
  1557. Gets or sets the fist offset to use with implicit field tags;
  1558. only uesd if ImplicitFields is set.
  1559. </summary>
  1560. </member>
  1561. <member name="P:ProtoBuf.ProtoContractAttribute.UseProtoMembersOnly">
  1562. <summary>
  1563. If specified, alternative contract markers (such as markers for XmlSerailizer or DataContractSerializer) are ignored.
  1564. </summary>
  1565. </member>
  1566. <member name="P:ProtoBuf.ProtoContractAttribute.IgnoreListHandling">
  1567. <summary>
  1568. If specified, do NOT treat this type as a list, even if it looks like one.
  1569. </summary>
  1570. </member>
  1571. <member name="P:ProtoBuf.ProtoContractAttribute.ImplicitFields">
  1572. <summary>
  1573. Gets or sets the mechanism used to automatically infer field tags
  1574. for members. This option should be used in advanced scenarios only.
  1575. Please review the important notes against the ImplicitFields enumeration.
  1576. </summary>
  1577. </member>
  1578. <member name="P:ProtoBuf.ProtoContractAttribute.InferTagFromName">
  1579. <summary>
  1580. Enables/disables automatic tag generation based on the existing name / order
  1581. of the defined members. This option is not used for members marked
  1582. with ProtoMemberAttribute, as intended to provide compatibility with
  1583. WCF serialization. WARNING: when adding new fields you must take
  1584. care to increase the Order for new elements, otherwise data corruption
  1585. may occur.
  1586. </summary>
  1587. <remarks>If not explicitly specified, the default is assumed from Serializer.GlobalOptions.InferTagFromName.</remarks>
  1588. </member>
  1589. <member name="P:ProtoBuf.ProtoContractAttribute.InferTagFromNameHasValue">
  1590. <summary>
  1591. Has a InferTagFromName value been explicitly set? if not, the default from the type-model is assumed.
  1592. </summary>
  1593. </member>
  1594. <member name="P:ProtoBuf.ProtoContractAttribute.DataMemberOffset">
  1595. <summary>
  1596. Specifies an offset to apply to [DataMember(Order=...)] markers;
  1597. this is useful when working with mex-generated classes that have
  1598. a different origin (usually 1 vs 0) than the original data-contract.
  1599. This value is added to the Order of each member.
  1600. </summary>
  1601. </member>
  1602. <member name="P:ProtoBuf.ProtoContractAttribute.SkipConstructor">
  1603. <summary>
  1604. If true, the constructor for the type is bypassed during deserialization, meaning any field initializers
  1605. or other initialization code is skipped.
  1606. </summary>
  1607. </member>
  1608. <member name="T:ProtoBuf.ProtoEnumAttribute">
  1609. <summary>
  1610. Used to define protocol-buffer specific behavior for
  1611. enumerated values.
  1612. </summary>
  1613. </member>
  1614. <member name="M:ProtoBuf.ProtoEnumAttribute.HasValue">
  1615. <summary>
  1616. Indicates whether this instance has a customised value mapping
  1617. </summary>
  1618. <returns>true if a specific value is set</returns>
  1619. </member>
  1620. <member name="P:ProtoBuf.ProtoEnumAttribute.Value">
  1621. <summary>
  1622. Gets or sets the specific value to use for this enum during serialization.
  1623. </summary>
  1624. </member>
  1625. <member name="P:ProtoBuf.ProtoEnumAttribute.Name">
  1626. <summary>
  1627. Gets or sets the defined name of the enum, as used in .proto
  1628. (this name is not used during serialization).
  1629. </summary>
  1630. </member>
  1631. <member name="T:ProtoBuf.ProtoException">
  1632. <summary>
  1633. Indicates an error during serialization/deserialization of a proto stream.
  1634. </summary>
  1635. </member>
  1636. <member name="M:ProtoBuf.ProtoException.#ctor">
  1637. <summary>Creates a new ProtoException instance.</summary>
  1638. </member>
  1639. <member name="M:ProtoBuf.ProtoException.#ctor(System.String)">
  1640. <summary>Creates a new ProtoException instance.</summary>
  1641. </member>
  1642. <member name="M:ProtoBuf.ProtoException.#ctor(System.String,System.Exception)">
  1643. <summary>Creates a new ProtoException instance.</summary>
  1644. </member>
  1645. <member name="T:ProtoBuf.ProtoIgnoreAttribute">
  1646. <summary>
  1647. Indicates that a member should be excluded from serialization; this
  1648. is only normally used when using implict fields.
  1649. </summary>
  1650. </member>
  1651. <member name="T:ProtoBuf.ProtoPartialIgnoreAttribute">
  1652. <summary>
  1653. Indicates that a member should be excluded from serialization; this
  1654. is only normally used when using implict fields. This allows
  1655. ProtoIgnoreAttribute usage
  1656. even for partial classes where the individual members are not
  1657. under direct control.
  1658. </summary>
  1659. </member>
  1660. <member name="M:ProtoBuf.ProtoPartialIgnoreAttribute.#ctor(System.String)">
  1661. <summary>
  1662. Creates a new ProtoPartialIgnoreAttribute instance.
  1663. </summary>
  1664. <param name="memberName">Specifies the member to be ignored.</param>
  1665. </member>
  1666. <member name="P:ProtoBuf.ProtoPartialIgnoreAttribute.MemberName">
  1667. <summary>
  1668. The name of the member to be ignored.
  1669. </summary>
  1670. </member>
  1671. <member name="T:ProtoBuf.ProtoIncludeAttribute">
  1672. <summary>
  1673. Indicates the known-types to support for an individual
  1674. message. This serializes each level in the hierarchy as
  1675. a nested message to retain wire-compatibility with
  1676. other protocol-buffer implementations.
  1677. </summary>
  1678. </member>
  1679. <member name="M:ProtoBuf.ProtoIncludeAttribute.#ctor(System.Int32,System.Type)">
  1680. <summary>
  1681. Creates a new instance of the ProtoIncludeAttribute.
  1682. </summary>
  1683. <param name="tag">The unique index (within the type) that will identify this data.</param>
  1684. <param name="knownType">The additional type to serialize/deserialize.</param>
  1685. </member>
  1686. <member name="M:ProtoBuf.ProtoIncludeAttribute.#ctor(System.Int32,System.String)">
  1687. <summary>
  1688. Creates a new instance of the ProtoIncludeAttribute.
  1689. </summary>
  1690. <param name="tag">The unique index (within the type) that will identify this data.</param>
  1691. <param name="knownTypeName">The additional type to serialize/deserialize.</param>
  1692. </member>
  1693. <member name="P:ProtoBuf.ProtoIncludeAttribute.Tag">
  1694. <summary>
  1695. Gets the unique index (within the type) that will identify this data.
  1696. </summary>
  1697. </member>
  1698. <member name="P:ProtoBuf.ProtoIncludeAttribute.KnownTypeName">
  1699. <summary>
  1700. Gets the additional type to serialize/deserialize.
  1701. </summary>
  1702. </member>
  1703. <member name="P:ProtoBuf.ProtoIncludeAttribute.KnownType">
  1704. <summary>
  1705. Gets the additional type to serialize/deserialize.
  1706. </summary>
  1707. </member>
  1708. <member name="P:ProtoBuf.ProtoIncludeAttribute.DataFormat">
  1709. <summary>
  1710. Specifies whether the inherited sype's sub-message should be
  1711. written with a length-prefix (default), or with group markers.
  1712. </summary>
  1713. </member>
  1714. <member name="T:ProtoBuf.ProtoMemberAttribute">
  1715. <summary>
  1716. Declares a member to be used in protocol-buffer serialization, using
  1717. the given Tag. A DataFormat may be used to optimise the serialization
  1718. format (for instance, using zigzag encoding for negative numbers, or
  1719. fixed-length encoding for large values.
  1720. </summary>
  1721. </member>
  1722. <member name="M:ProtoBuf.ProtoMemberAttribute.CompareTo(System.Object)">
  1723. <summary>
  1724. Compare with another ProtoMemberAttribute for sorting purposes
  1725. </summary>
  1726. </member>
  1727. <member name="M:ProtoBuf.ProtoMemberAttribute.CompareTo(ProtoBuf.ProtoMemberAttribute)">
  1728. <summary>
  1729. Compare with another ProtoMemberAttribute for sorting purposes
  1730. </summary>
  1731. </member>
  1732. <member name="M:ProtoBuf.ProtoMemberAttribute.#ctor(System.Int32)">
  1733. <summary>
  1734. Creates a new ProtoMemberAttribute instance.
  1735. </summary>
  1736. <param name="tag">Specifies the unique tag used to identify this member within the type.</param>
  1737. </member>
  1738. <member name="P:ProtoBuf.ProtoMemberAttribute.Name">
  1739. <summary>
  1740. Gets or sets the original name defined in the .proto; not used
  1741. during serialization.
  1742. </summary>
  1743. </member>
  1744. <member name="P:ProtoBuf.ProtoMemberAttribute.DataFormat">
  1745. <summary>
  1746. Gets or sets the data-format to be used when encoding this value.
  1747. </summary>
  1748. </member>
  1749. <member name="P:ProtoBuf.ProtoMemberAttribute.Tag">
  1750. <summary>
  1751. Gets the unique tag used to identify this member within the type.
  1752. </summary>
  1753. </member>
  1754. <member name="P:ProtoBuf.ProtoMemberAttribute.IsRequired">
  1755. <summary>
  1756. Gets or sets a value indicating whether this member is mandatory.
  1757. </summary>
  1758. </member>
  1759. <member name="P:ProtoBuf.ProtoMemberAttribute.IsPacked">
  1760. <summary>
  1761. Gets a value indicating whether this member is packed.
  1762. This option only applies to list/array data of primitive types (int, double, etc).
  1763. </summary>
  1764. </member>
  1765. <member name="P:ProtoBuf.ProtoMemberAttribute.OverwriteList">
  1766. <summary>
  1767. Indicates whether this field should *repace* existing values (the default is false, meaning *append*).
  1768. This option only applies to list/array data.
  1769. </summary>
  1770. </member>
  1771. <member name="P:ProtoBuf.ProtoMemberAttribute.AsReference">
  1772. <summary>
  1773. Enables full object-tracking/full-graph support.
  1774. </summary>
  1775. </member>
  1776. <member name="P:ProtoBuf.ProtoMemberAttribute.DynamicType">
  1777. <summary>
  1778. Embeds the type information into the stream, allowing usage with types not known in advance.
  1779. </summary>
  1780. </member>
  1781. <member name="P:ProtoBuf.ProtoMemberAttribute.Options">
  1782. <summary>
  1783. Gets or sets a value indicating whether this member is packed (lists/arrays).
  1784. </summary>
  1785. </member>
  1786. <member name="T:ProtoBuf.MemberSerializationOptions">
  1787. <summary>
  1788. Additional (optional) settings that control serialization of members
  1789. </summary>
  1790. </member>
  1791. <member name="F:ProtoBuf.MemberSerializationOptions.None">
  1792. <summary>
  1793. Default; no additional options
  1794. </summary>
  1795. </member>
  1796. <member name="F:ProtoBuf.MemberSerializationOptions.Packed">
  1797. <summary>
  1798. Indicates that repeated elements should use packed (length-prefixed) encoding
  1799. </summary>
  1800. </member>
  1801. <member name="F:ProtoBuf.MemberSerializationOptions.Required">
  1802. <summary>
  1803. Indicates that the given item is required
  1804. </summary>
  1805. </member>
  1806. <member name="F:ProtoBuf.MemberSerializationOptions.AsReference">
  1807. <summary>
  1808. Enables full object-tracking/full-graph support
  1809. </summary>
  1810. </member>
  1811. <member name="F:ProtoBuf.MemberSerializationOptions.DynamicType">
  1812. <summary>
  1813. Embeds the type information into the stream, allowing usage with types not known in advance
  1814. </summary>
  1815. </member>
  1816. <member name="F:ProtoBuf.MemberSerializationOptions.OverwriteList">
  1817. <summary>
  1818. Indicates whether this field should *repace* existing values (the default is false, meaning *append*).
  1819. This option only applies to list/array data.
  1820. </summary>
  1821. </member>
  1822. <member name="T:ProtoBuf.ProtoPartialMemberAttribute">
  1823. <summary>
  1824. Declares a member to be used in protocol-buffer serialization, using
  1825. the given Tag and MemberName. This allows ProtoMemberAttribute usage
  1826. even for partial classes where the individual members are not
  1827. under direct control.
  1828. A DataFormat may be used to optimise the serialization
  1829. format (for instance, using zigzag encoding for negative numbers, or
  1830. fixed-length encoding for large values.
  1831. </summary>
  1832. </member>
  1833. <member name="M:ProtoBuf.ProtoPartialMemberAttribute.#ctor(System.Int32,System.String)">
  1834. <summary>
  1835. Creates a new ProtoMemberAttribute instance.
  1836. </summary>
  1837. <param name="tag">Specifies the unique tag used to identify this member within the type.</param>
  1838. <param name="memberName">Specifies the member to be serialized.</param>
  1839. </member>
  1840. <member name="P:ProtoBuf.ProtoPartialMemberAttribute.MemberName">
  1841. <summary>
  1842. The name of the member to be serialized.
  1843. </summary>
  1844. </member>
  1845. <member name="T:ProtoBuf.ProtoReader">
  1846. <summary>
  1847. A stateful reader, used to read a protobuf stream. Typical usage would be (sequentially) to call
  1848. ReadFieldHeader and (after matching the field) an appropriate Read* method.
  1849. </summary>
  1850. </member>
  1851. <member name="M:ProtoBuf.ProtoReader.#ctor(System.IO.Stream,ProtoBuf.Meta.TypeModel,ProtoBuf.SerializationContext)">
  1852. <summary>
  1853. Creates a new reader against a stream
  1854. </summary>
  1855. <param name="source">The source stream</param>
  1856. <param name="model">The model to use for serialization; this can be null, but this will impair the ability to deserialize sub-objects</param>
  1857. <param name="context">Additional context about this serialization operation</param>
  1858. </member>
  1859. <member name="M:ProtoBuf.ProtoReader.#ctor(System.IO.Stream,ProtoBuf.Meta.TypeModel,ProtoBuf.SerializationContext,System.Int32)">
  1860. <summary>
  1861. Creates a new reader against a stream
  1862. </summary>
  1863. <param name="source">The source stream</param>
  1864. <param name="model">The model to use for serialization; this can be null, but this will impair the ability to deserialize sub-objects</param>
  1865. <param name="context">Additional context about this serialization operation</param>
  1866. <param name="length">The number of bytes to read, or -1 to read until the end of the stream</param>
  1867. </member>
  1868. <member name="M:ProtoBuf.ProtoReader.Dispose">
  1869. <summary>
  1870. Releases resources used by the reader, but importantly <b>does not</b> Dispose the
  1871. underlying stream; in many typical use-cases the stream is used for different
  1872. processes, so it is assumed that the consumer will Dispose their stream separately.
  1873. </summary>
  1874. </member>
  1875. <member name="M:ProtoBuf.ProtoReader.ReadUInt32">
  1876. <summary>
  1877. Reads an unsigned 32-bit integer from the stream; supported wire-types: Variant, Fixed32, Fixed64
  1878. </summary>
  1879. </member>
  1880. <member name="M:ProtoBuf.ProtoReader.ReadInt16">
  1881. <summary>
  1882. Reads a signed 16-bit integer from the stream: Variant, Fixed32, Fixed64, SignedVariant
  1883. </summary>
  1884. </member>
  1885. <member name="M:ProtoBuf.ProtoReader.ReadUInt16">
  1886. <summary>
  1887. Reads an unsigned 16-bit integer from the stream; supported wire-types: Variant, Fixed32, Fixed64
  1888. </summary>
  1889. </member>
  1890. <member name="M:ProtoBuf.ProtoReader.ReadByte">
  1891. <summary>
  1892. Reads an unsigned 8-bit integer from the stream; supported wire-types: Variant, Fixed32, Fixed64
  1893. </summary>
  1894. </member>
  1895. <member name="M:ProtoBuf.ProtoReader.ReadSByte">
  1896. <summary>
  1897. Reads a signed 8-bit integer from the stream; supported wire-types: Variant, Fixed32, Fixed64, SignedVariant
  1898. </summary>
  1899. </member>
  1900. <member name="M:ProtoBuf.ProtoReader.ReadInt32">
  1901. <summary>
  1902. Reads a signed 32-bit integer from the stream; supported wire-types: Variant, Fixed32, Fixed64, SignedVariant
  1903. </summary>
  1904. </member>
  1905. <member name="M:ProtoBuf.ProtoReader.ReadInt64">
  1906. <summary>
  1907. Reads a signed 64-bit integer from the stream; supported wire-types: Variant, Fixed32, Fixed64, SignedVariant
  1908. </summary>
  1909. </member>
  1910. <member name="M:ProtoBuf.ProtoReader.ReadString">
  1911. <summary>
  1912. Reads a string from the stream (using UTF8); supported wire-types: String
  1913. </summary>
  1914. </member>
  1915. <member name="M:ProtoBuf.ProtoReader.ThrowEnumException(System.Type,System.Int32)">
  1916. <summary>
  1917. Throws an exception indication that the given value cannot be mapped to an enum.
  1918. </summary>
  1919. </member>
  1920. <member name="M:ProtoBuf.ProtoReader.ReadDouble">
  1921. <summary>
  1922. Reads a double-precision number from the stream; supported wire-types: Fixed32, Fixed64
  1923. </summary>
  1924. </member>
  1925. <member name="M:ProtoBuf.ProtoReader.ReadObject(System.Object,System.Int32,ProtoBuf.ProtoReader)">
  1926. <summary>
  1927. Reads (merges) a sub-message from the stream, internally calling StartSubItem and EndSubItem, and (in between)
  1928. parsing the message in accordance with the model associated with the reader
  1929. </summary>
  1930. </member>
  1931. <member name="M:ProtoBuf.ProtoReader.EndSubItem(ProtoBuf.SubItemToken,ProtoBuf.ProtoReader)">
  1932. <summary>
  1933. Makes the end of consuming a nested message in the stream; the stream must be either at the correct EndGroup
  1934. marker, or all fields of the sub-message must have been consumed (in either case, this means ReadFieldHeader
  1935. should return zero)
  1936. </summary>
  1937. </member>
  1938. <member name="M:ProtoBuf.ProtoReader.StartSubItem(ProtoBuf.ProtoReader)">
  1939. <summary>
  1940. Begins consuming a nested message in the stream; supported wire-types: StartGroup, String
  1941. </summary>
  1942. <remarks>The token returned must be help and used when callining EndSubItem</remarks>
  1943. </member>
  1944. <member name="M:ProtoBuf.ProtoReader.ReadFieldHeader">
  1945. <summary>
  1946. Reads a field header from the stream, setting the wire-type and retuning the field number. If no
  1947. more fields are available, then 0 is returned. This methods respects sub-messages.
  1948. </summary>
  1949. </member>
  1950. <member name="M:ProtoBuf.ProtoReader.TryReadFieldHeader(System.Int32)">
  1951. <summary>
  1952. Looks ahead to see whether the next field in the stream is what we expect
  1953. (typically; what we've just finished reading - for example ot read successive list items)
  1954. </summary>
  1955. </member>
  1956. <member name="M:ProtoBuf.ProtoReader.Hint(ProtoBuf.WireType)">
  1957. <summary>
  1958. Compares the streams current wire-type to the hinted wire-type, updating the reader if necessary; for example,
  1959. a Variant may be updated to SignedVariant. If the hinted wire-type is unrelated then no change is made.
  1960. </summary>
  1961. </member>
  1962. <member name="M:ProtoBuf.ProtoReader.Assert(ProtoBuf.WireType)">
  1963. <summary>
  1964. Verifies that the stream's current wire-type is as expected, or a specialized sub-type (for example,
  1965. SignedVariant) - in which case the current wire-type is updated. Otherwise an exception is thrown.
  1966. </summary>
  1967. </member>
  1968. <member name="M:ProtoBuf.ProtoReader.SkipField">
  1969. <summary>
  1970. Discards the data for the current field.
  1971. </summary>
  1972. </member>
  1973. <member name="M:ProtoBuf.ProtoReader.ReadUInt64">
  1974. <summary>
  1975. Reads an unsigned 64-bit integer from the stream; supported wire-types: Variant, Fixed32, Fixed64
  1976. </summary>
  1977. </member>
  1978. <member name="M:ProtoBuf.ProtoReader.ReadSingle">
  1979. <summary>
  1980. Reads a single-precision number from the stream; supported wire-types: Fixed32, Fixed64
  1981. </summary>
  1982. </member>
  1983. <member name="M:ProtoBuf.ProtoReader.ReadBoolean">
  1984. <summary>
  1985. Reads a boolean value from the stream; supported wire-types: Variant, Fixed32, Fixed64
  1986. </summary>
  1987. <returns></returns>
  1988. </member>
  1989. <member name="M:ProtoBuf.ProtoReader.AppendBytes(System.Byte[],ProtoBuf.ProtoReader)">
  1990. <summary>
  1991. Reads a byte-sequence from the stream, appending them to an existing byte-sequence (which can be null); supported wire-types: String
  1992. </summary>
  1993. </member>
  1994. <member name="M:ProtoBuf.ProtoReader.ReadLengthPrefix(System.IO.Stream,System.Boolean,ProtoBuf.PrefixStyle,System.Int32@)">
  1995. <summary>
  1996. Reads the length-prefix of a message from a stream without buffering additional data, allowing a fixed-length
  1997. reader to be created.
  1998. </summary>
  1999. </member>
  2000. <member name="M:ProtoBuf.ProtoReader.DirectReadLittleEndianInt32(System.IO.Stream)">
  2001. <summary>
  2002. Reads a little-endian encoded integer. An exception is thrown if the data is not all available.
  2003. </summary>
  2004. </member>
  2005. <member name="M:ProtoBuf.ProtoReader.DirectReadBigEndianInt32(System.IO.Stream)">
  2006. <summary>
  2007. Reads a big-endian encoded integer. An exception is thrown if the data is not all available.
  2008. </summary>
  2009. </member>
  2010. <member name="M:ProtoBuf.ProtoReader.DirectReadVarintInt32(System.IO.Stream)">
  2011. <summary>
  2012. Reads a varint encoded integer. An exception is thrown if the data is not all available.
  2013. </summary>
  2014. </member>
  2015. <member name="M:ProtoBuf.ProtoReader.DirectReadBytes(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
  2016. <summary>
  2017. Reads a string (of a given lenth, in bytes) directly from the source into a pre-existing buffer. An exception is thrown if the data is not all available.
  2018. </summary>
  2019. </member>
  2020. <member name="M:ProtoBuf.ProtoReader.DirectReadBytes(System.IO.Stream,System.Int32)">
  2021. <summary>
  2022. Reads a given number of bytes directly from the source. An exception is thrown if the data is not all available.
  2023. </summary>
  2024. </member>
  2025. <member name="M:ProtoBuf.ProtoReader.DirectReadString(System.IO.Stream,System.Int32)">
  2026. <summary>
  2027. Reads a string (of a given lenth, in bytes) directly from the source. An exception is thrown if the data is not all available.
  2028. </summary>
  2029. </member>
  2030. <member name="M:ProtoBuf.ProtoReader.ReadLengthPrefix(System.IO.Stream,System.Boolean,ProtoBuf.PrefixStyle,System.Int32@,System.Int32@)">
  2031. <summary>
  2032. Reads the length-prefix of a message from a stream without buffering additional data, allowing a fixed-length
  2033. reader to be created.
  2034. </summary>
  2035. </member>
  2036. <member name="M:ProtoBuf.ProtoReader.TryReadUInt32Variant(System.IO.Stream,System.UInt32@)">
  2037. <returns>The number of bytes consumed; 0 if no data available</returns>
  2038. </member>
  2039. <member name="M:ProtoBuf.ProtoReader.AppendExtensionData(ProtoBuf.IExtensible)">
  2040. <summary>
  2041. Copies the current field into the instance as extension data
  2042. </summary>
  2043. </member>
  2044. <member name="M:ProtoBuf.ProtoReader.HasSubValue(ProtoBuf.WireType,ProtoBuf.ProtoReader)">
  2045. <summary>
  2046. Indicates whether the reader still has data remaining in the current sub-item,
  2047. additionally setting the wire-type for the next field if there is more data.
  2048. This is used when decoding packed data.
  2049. </summary>
  2050. </member>
  2051. <member name="M:ProtoBuf.ProtoReader.NoteObject(System.Object,ProtoBuf.ProtoReader)">
  2052. <summary>
  2053. Utility method, not intended for public use; this helps maintain the root object is complex scenarios
  2054. </summary>
  2055. </member>
  2056. <member name="M:ProtoBuf.ProtoReader.ReadType">
  2057. <summary>
  2058. Reads a Type from the stream, using the model's DynamicTypeFormatting if appropriate; supported wire-types: String
  2059. </summary>
  2060. </member>
  2061. <member name="M:ProtoBuf.ProtoReader.Merge(ProtoBuf.ProtoReader,System.Object,System.Object)">
  2062. <summary>
  2063. Merge two objects using the details from the current reader; this is used to change the type
  2064. of objects when an inheritance relationship is discovered later than usual during deserilazation.
  2065. </summary>
  2066. </member>
  2067. <member name="P:ProtoBuf.ProtoReader.FieldNumber">
  2068. <summary>
  2069. Gets the number of the field being processed.
  2070. </summary>
  2071. </member>
  2072. <member name="P:ProtoBuf.ProtoReader.WireType">
  2073. <summary>
  2074. Indicates the underlying proto serialization format on the wire.
  2075. </summary>
  2076. </member>
  2077. <member name="P:ProtoBuf.ProtoReader.InternStrings">
  2078. <summary>
  2079. Gets / sets a flag indicating whether strings should be checked for repetition; if
  2080. true, any repeated UTF-8 byte sequence will result in the same String instance, rather
  2081. than a second instance of the same string. Enabled by default. Note that this uses
  2082. a <i>custom</i> interner - the system-wide string interner is not used.
  2083. </summary>
  2084. </member>
  2085. <member name="P:ProtoBuf.ProtoReader.Context">
  2086. <summary>
  2087. Addition information about this deserialization operation.
  2088. </summary>
  2089. </member>
  2090. <member name="P:ProtoBuf.ProtoReader.Position">
  2091. <summary>
  2092. Returns the position of the current reader (note that this is not necessarily the same as the position
  2093. in the underlying stream, if multiple readers are used on the same stream)
  2094. </summary>
  2095. </member>
  2096. <member name="P:ProtoBuf.ProtoReader.Model">
  2097. <summary>
  2098. Get the TypeModel associated with this reader
  2099. </summary>
  2100. </member>
  2101. <member name="T:ProtoBuf.ProtoWriter">
  2102. <summary>
  2103. Represents an output stream for writing protobuf data.
  2104. Why is the API backwards (static methods with writer arguments)?
  2105. See: http://marcgravell.blogspot.com/2010/03/last-will-be-first-and-first-will-be.html
  2106. </summary>
  2107. </member>
  2108. <member name="M:ProtoBuf.ProtoWriter.WriteObject(System.Object,System.Int32,ProtoBuf.ProtoWriter)">
  2109. <summary>
  2110. Write an encapsulated sub-object, using the supplied unique key (reprasenting a type).
  2111. </summary>
  2112. <param name="value">The object to write.</param>
  2113. <param name="key">The key that uniquely identifies the type within the model.</param>
  2114. <param name="writer">The destination.</param>
  2115. </member>
  2116. <member name="M:ProtoBuf.ProtoWriter.WriteRecursionSafeObject(System.Object,System.Int32,ProtoBuf.ProtoWriter)">
  2117. <summary>
  2118. Write an encapsulated sub-object, using the supplied unique key (reprasenting a type) - but the
  2119. caller is asserting that this relationship is non-recursive; no recursion check will be
  2120. performed.
  2121. </summary>
  2122. <param name="value">The object to write.</param>
  2123. <param name="key">The key that uniquely identifies the type within the model.</param>
  2124. <param name="writer">The destination.</param>
  2125. </member>
  2126. <member name="M:ProtoBuf.ProtoWriter.WriteFieldHeader(System.Int32,ProtoBuf.WireType,ProtoBuf.ProtoWriter)">
  2127. <summary>
  2128. Writes a field-header, indicating the format of the next data we plan to write.
  2129. </summary>
  2130. </member>
  2131. <member name="M:ProtoBuf.ProtoWriter.WriteBytes(System.Byte[],ProtoBuf.ProtoWriter)">
  2132. <summary>
  2133. Writes a byte-array to the stream; supported wire-types: String
  2134. </summary>
  2135. </member>
  2136. <member name="M:ProtoBuf.ProtoWriter.WriteBytes(System.Byte[],System.Int32,System.Int32,ProtoBuf.ProtoWriter)">
  2137. <summary>
  2138. Writes a byte-array to the stream; supported wire-types: String
  2139. </summary>
  2140. </member>
  2141. <member name="M:ProtoBuf.ProtoWriter.StartSubItem(System.Object,ProtoBuf.ProtoWriter)">
  2142. <summary>
  2143. Indicates the start of a nested record.
  2144. </summary>
  2145. <param name="instance">The instance to write.</param>
  2146. <param name="writer">The destination.</param>
  2147. <returns>A token representing the state of the stream; this token is given to EndSubItem.</returns>
  2148. </member>
  2149. <member name="M:ProtoBuf.ProtoWriter.EndSubItem(ProtoBuf.SubItemToken,ProtoBuf.ProtoWriter)">
  2150. <summary>
  2151. Indicates the end of a nested record.
  2152. </summary>
  2153. <param name="token">The token obtained from StartubItem.</param>
  2154. <param name="writer">The destination.</param>
  2155. </member>
  2156. <member name="M:ProtoBuf.ProtoWriter.#ctor(System.IO.Stream,ProtoBuf.Meta.TypeModel,ProtoBuf.SerializationContext)">
  2157. <summary>
  2158. Creates a new writer against a stream
  2159. </summary>
  2160. <param name="dest">The destination stream</param>
  2161. <param name="model">The model to use for serialization; this can be null, but this will impair the ability to serialize sub-objects</param>
  2162. <param name="context">Additional context about this serialization operation</param>
  2163. </member>
  2164. <member name="M:ProtoBuf.ProtoWriter.Close">
  2165. <summary>
  2166. Flushes data to the underlying stream, and releases any resources. The underlying stream is *not* disposed
  2167. by this operation.
  2168. </summary>
  2169. </member>
  2170. <member name="M:ProtoBuf.ProtoWriter.Flush(ProtoBuf.ProtoWriter)">
  2171. <summary>
  2172. Writes any buffered data (if possible) to the underlying stream.
  2173. </summary>
  2174. <param name="writer">The writer to flush</param>
  2175. <remarks>It is not always possible to fully flush, since some sequences
  2176. may require values to be back-filled into the byte-stream.</remarks>
  2177. </member>
  2178. <member name="M:ProtoBuf.ProtoWriter.WriteUInt32Variant(System.UInt32,ProtoBuf.ProtoWriter)">
  2179. <summary>
  2180. Writes an unsigned 32-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64
  2181. </summary>
  2182. </member>
  2183. <member name="M:ProtoBuf.ProtoWriter.WriteString(System.String,ProtoBuf.ProtoWriter)">
  2184. <summary>
  2185. Writes a string to the stream; supported wire-types: String
  2186. </summary>
  2187. </member>
  2188. <member name="M:ProtoBuf.ProtoWriter.WriteUInt64(System.UInt64,ProtoBuf.ProtoWriter)">
  2189. <summary>
  2190. Writes an unsigned 64-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64
  2191. </summary>
  2192. </member>
  2193. <member name="M:ProtoBuf.ProtoWriter.WriteInt64(System.Int64,ProtoBuf.ProtoWriter)">
  2194. <summary>
  2195. Writes a signed 64-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64, SignedVariant
  2196. </summary>
  2197. </member>
  2198. <member name="M:ProtoBuf.ProtoWriter.WriteUInt32(System.UInt32,ProtoBuf.ProtoWriter)">
  2199. <summary>
  2200. Writes an unsigned 16-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64
  2201. </summary>
  2202. </member>
  2203. <member name="M:ProtoBuf.ProtoWriter.WriteInt16(System.Int16,ProtoBuf.ProtoWriter)">
  2204. <summary>
  2205. Writes a signed 16-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64, SignedVariant
  2206. </summary>
  2207. </member>
  2208. <member name="M:ProtoBuf.ProtoWriter.WriteUInt16(System.UInt16,ProtoBuf.ProtoWriter)">
  2209. <summary>
  2210. Writes an unsigned 16-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64
  2211. </summary>
  2212. </member>
  2213. <member name="M:ProtoBuf.ProtoWriter.WriteByte(System.Byte,ProtoBuf.ProtoWriter)">
  2214. <summary>
  2215. Writes an unsigned 8-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64
  2216. </summary>
  2217. </member>
  2218. <member name="M:ProtoBuf.ProtoWriter.WriteSByte(System.SByte,ProtoBuf.ProtoWriter)">
  2219. <summary>
  2220. Writes a signed 8-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64, SignedVariant
  2221. </summary>
  2222. </member>
  2223. <member name="M:ProtoBuf.ProtoWriter.WriteInt32(System.Int32,ProtoBuf.ProtoWriter)">
  2224. <summary>
  2225. Writes a signed 32-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64, SignedVariant
  2226. </summary>
  2227. </member>
  2228. <member name="M:ProtoBuf.ProtoWriter.WriteDouble(System.Double,ProtoBuf.ProtoWriter)">
  2229. <summary>
  2230. Writes a double-precision number to the stream; supported wire-types: Fixed32, Fixed64
  2231. </summary>
  2232. </member>
  2233. <member name="M:ProtoBuf.ProtoWriter.WriteSingle(System.Single,ProtoBuf.ProtoWriter)">
  2234. <summary>
  2235. Writes a single-precision number to the stream; supported wire-types: Fixed32, Fixed64
  2236. </summary>
  2237. </member>
  2238. <member name="M:ProtoBuf.ProtoWriter.ThrowEnumException(ProtoBuf.ProtoWriter,System.Object)">
  2239. <summary>
  2240. Throws an exception indicating that the given enum cannot be mapped to a serialized value.
  2241. </summary>
  2242. </member>
  2243. <member name="M:ProtoBuf.ProtoWriter.WriteBoolean(System.Boolean,ProtoBuf.ProtoWriter)">
  2244. <summary>
  2245. Writes a boolean to the stream; supported wire-types: Variant, Fixed32, Fixed64
  2246. </summary>
  2247. </member>
  2248. <member name="M:ProtoBuf.ProtoWriter.AppendExtensionData(ProtoBuf.IExtensible,ProtoBuf.ProtoWriter)">
  2249. <summary>
  2250. Copies any extension data stored for the instance to the underlying stream
  2251. </summary>
  2252. </member>
  2253. <member name="M:ProtoBuf.ProtoWriter.SetPackedField(System.Int32,ProtoBuf.ProtoWriter)">
  2254. <summary>
  2255. Used for packed encoding; indicates that the next field should be skipped rather than
  2256. a field header written. Note that the field number must match, else an exception is thrown
  2257. when the attempt is made to write the (incorrect) field. The wire-type is taken from the
  2258. subsequent call to WriteFieldHeader. Only primitive types can be packed.
  2259. </summary>
  2260. </member>
  2261. <member name="M:ProtoBuf.ProtoWriter.SetRootObject(System.Object)">
  2262. <summary>
  2263. Specifies a known root object to use during reference-tracked serialization
  2264. </summary>
  2265. </member>
  2266. <member name="M:ProtoBuf.ProtoWriter.WriteType(System.Type,ProtoBuf.ProtoWriter)">
  2267. <summary>
  2268. Writes a Type to the stream, using the model's DynamicTypeFormatting if appropriate; supported wire-types: String
  2269. </summary>
  2270. </member>
  2271. <member name="P:ProtoBuf.ProtoWriter.Context">
  2272. <summary>
  2273. Addition information about this serialization operation.
  2274. </summary>
  2275. </member>
  2276. <member name="P:ProtoBuf.ProtoWriter.Model">
  2277. <summary>
  2278. Get the TypeModel associated with this writer
  2279. </summary>
  2280. </member>
  2281. <member name="T:ProtoBuf.SerializationContext">
  2282. <summary>
  2283. Additional information about a serialization operation
  2284. </summary>
  2285. </member>
  2286. <member name="M:ProtoBuf.SerializationContext.op_Implicit(ProtoBuf.SerializationContext)~System.Runtime.Serialization.StreamingContext">
  2287. <summary>
  2288. Convert a SerializationContext to a StreamingContext
  2289. </summary>
  2290. </member>
  2291. <member name="M:ProtoBuf.SerializationContext.op_Implicit(System.Runtime.Serialization.StreamingContext)~ProtoBuf.SerializationContext">
  2292. <summary>
  2293. Convert a StreamingContext to a SerializationContext
  2294. </summary>
  2295. </member>
  2296. <member name="P:ProtoBuf.SerializationContext.Context">
  2297. <summary>
  2298. Gets or sets a user-defined object containing additional information about this serialization/deserialization operation.
  2299. </summary>
  2300. </member>
  2301. <member name="P:ProtoBuf.SerializationContext.Default">
  2302. <summary>
  2303. A default SerializationContext, with minimal information.
  2304. </summary>
  2305. </member>
  2306. <member name="P:ProtoBuf.SerializationContext.State">
  2307. <summary>
  2308. Gets or sets the source or destination of the transmitted data.
  2309. </summary>
  2310. </member>
  2311. <member name="T:ProtoBuf.Serializer">
  2312. <summary>
  2313. Provides protocol-buffer serialization capability for concrete, attributed types. This
  2314. is a *default* model, but custom serializer models are also supported.
  2315. </summary>
  2316. <remarks>
  2317. Protocol-buffer serialization is a compact binary format, designed to take
  2318. advantage of sparse data and knowledge of specific data types; it is also
  2319. extensible, allowing a type to be deserialized / merged even if some data is
  2320. not recognised.
  2321. </remarks>
  2322. </member>
  2323. <member name="F:ProtoBuf.Serializer.ListItemTag">
  2324. <summary>
  2325. The field number that is used as a default when serializing/deserializing a list of objects.
  2326. The data is treated as repeated message with field number 1.
  2327. </summary>
  2328. </member>
  2329. <member name="M:ProtoBuf.Serializer.GetProto``1">
  2330. <summary>
  2331. Suggest a .proto definition for the given type
  2332. </summary>
  2333. <typeparam name="T">The type to generate a .proto definition for</typeparam>
  2334. <returns>The .proto definition as a string</returns>
  2335. </member>
  2336. <member name="M:ProtoBuf.Serializer.DeepClone``1(``0)">
  2337. <summary>
  2338. Create a deep clone of the supplied instance; any sub-items are also cloned.
  2339. </summary>
  2340. </member>
  2341. <member name="M:ProtoBuf.Serializer.Merge``1(System.IO.Stream,``0)">
  2342. <summary>
  2343. Applies a protocol-buffer stream to an existing instance.
  2344. </summary>
  2345. <typeparam name="T">The type being merged.</typeparam>
  2346. <param name="instance">The existing instance to be modified (can be null).</param>
  2347. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  2348. <returns>The updated instance; this may be different to the instance argument if
  2349. either the original instance was null, or the stream defines a known sub-type of the
  2350. original instance.</returns>
  2351. </member>
  2352. <member name="M:ProtoBuf.Serializer.Deserialize``1(System.IO.Stream)">
  2353. <summary>
  2354. Creates a new instance from a protocol-buffer stream
  2355. </summary>
  2356. <typeparam name="T">The type to be created.</typeparam>
  2357. <param name="source">The binary stream to apply to the new instance (cannot be null).</param>
  2358. <returns>A new, initialized instance.</returns>
  2359. </member>
  2360. <member name="M:ProtoBuf.Serializer.Serialize``1(System.IO.Stream,``0)">
  2361. <summary>
  2362. Writes a protocol-buffer representation of the given instance to the supplied stream.
  2363. </summary>
  2364. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  2365. <param name="destination">The destination stream to write to.</param>
  2366. </member>
  2367. <member name="M:ProtoBuf.Serializer.ChangeType``2(``0)">
  2368. <summary>
  2369. Serializes a given instance and deserializes it as a different type;
  2370. this can be used to translate between wire-compatible objects (where
  2371. two .NET types represent the same data), or to promote/demote a type
  2372. through an inheritance hierarchy.
  2373. </summary>
  2374. <remarks>No assumption of compatibility is made between the types.</remarks>
  2375. <typeparam name="TFrom">The type of the object being copied.</typeparam>
  2376. <typeparam name="TTo">The type of the new object to be created.</typeparam>
  2377. <param name="instance">The existing instance to use as a template.</param>
  2378. <returns>A new instane of type TNewType, with the data from TOldType.</returns>
  2379. </member>
  2380. <member name="M:ProtoBuf.Serializer.Serialize``1(System.Runtime.Serialization.SerializationInfo,``0)">
  2381. <summary>
  2382. Writes a protocol-buffer representation of the given instance to the supplied SerializationInfo.
  2383. </summary>
  2384. <typeparam name="T">The type being serialized.</typeparam>
  2385. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  2386. <param name="info">The destination SerializationInfo to write to.</param>
  2387. </member>
  2388. <member name="M:ProtoBuf.Serializer.Serialize``1(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext,``0)">
  2389. <summary>
  2390. Writes a protocol-buffer representation of the given instance to the supplied SerializationInfo.
  2391. </summary>
  2392. <typeparam name="T">The type being serialized.</typeparam>
  2393. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  2394. <param name="info">The destination SerializationInfo to write to.</param>
  2395. <param name="context">Additional information about this serialization operation.</param>
  2396. </member>
  2397. <member name="M:ProtoBuf.Serializer.Serialize``1(System.Xml.XmlWriter,``0)">
  2398. <summary>
  2399. Writes a protocol-buffer representation of the given instance to the supplied XmlWriter.
  2400. </summary>
  2401. <typeparam name="T">The type being serialized.</typeparam>
  2402. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  2403. <param name="writer">The destination XmlWriter to write to.</param>
  2404. </member>
  2405. <member name="M:ProtoBuf.Serializer.Merge``1(System.Xml.XmlReader,``0)">
  2406. <summary>
  2407. Applies a protocol-buffer from an XmlReader to an existing instance.
  2408. </summary>
  2409. <typeparam name="T">The type being merged.</typeparam>
  2410. <param name="instance">The existing instance to be modified (cannot be null).</param>
  2411. <param name="reader">The XmlReader containing the data to apply to the instance (cannot be null).</param>
  2412. </member>
  2413. <member name="M:ProtoBuf.Serializer.Merge``1(System.Runtime.Serialization.SerializationInfo,``0)">
  2414. <summary>
  2415. Applies a protocol-buffer from a SerializationInfo to an existing instance.
  2416. </summary>
  2417. <typeparam name="T">The type being merged.</typeparam>
  2418. <param name="instance">The existing instance to be modified (cannot be null).</param>
  2419. <param name="info">The SerializationInfo containing the data to apply to the instance (cannot be null).</param>
  2420. </member>
  2421. <member name="M:ProtoBuf.Serializer.Merge``1(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext,``0)">
  2422. <summary>
  2423. Applies a protocol-buffer from a SerializationInfo to an existing instance.
  2424. </summary>
  2425. <typeparam name="T">The type being merged.</typeparam>
  2426. <param name="instance">The existing instance to be modified (cannot be null).</param>
  2427. <param name="info">The SerializationInfo containing the data to apply to the instance (cannot be null).</param>
  2428. <param name="context">Additional information about this serialization operation.</param>
  2429. </member>
  2430. <member name="M:ProtoBuf.Serializer.PrepareSerializer``1">
  2431. <summary>
  2432. Precompiles the serializer for a given type.
  2433. </summary>
  2434. </member>
  2435. <member name="M:ProtoBuf.Serializer.CreateFormatter``1">
  2436. <summary>
  2437. Creates a new IFormatter that uses protocol-buffer [de]serialization.
  2438. </summary>
  2439. <typeparam name="T">The type of object to be [de]deserialized by the formatter.</typeparam>
  2440. <returns>A new IFormatter to be used during [de]serialization.</returns>
  2441. </member>
  2442. <member name="M:ProtoBuf.Serializer.DeserializeItems``1(System.IO.Stream,ProtoBuf.PrefixStyle,System.Int32)">
  2443. <summary>
  2444. Reads a sequence of consecutive length-prefixed items from a stream, using
  2445. either base-128 or fixed-length prefixes. Base-128 prefixes with a tag
  2446. are directly comparable to serializing multiple items in succession
  2447. (use the <see cref="F:ProtoBuf.Serializer.ListItemTag"/> tag to emulate the implicit behavior
  2448. when serializing a list/array). When a tag is
  2449. specified, any records with different tags are silently omitted. The
  2450. tag is ignored. The tag is ignores for fixed-length prefixes.
  2451. </summary>
  2452. <typeparam name="T">The type of object to deserialize.</typeparam>
  2453. <param name="source">The binary stream containing the serialized records.</param>
  2454. <param name="style">The prefix style used in the data.</param>
  2455. <param name="fieldNumber">The tag of records to return (if non-positive, then no tag is
  2456. expected and all records are returned).</param>
  2457. <returns>The sequence of deserialized objects.</returns>
  2458. </member>
  2459. <member name="M:ProtoBuf.Serializer.DeserializeWithLengthPrefix``1(System.IO.Stream,ProtoBuf.PrefixStyle)">
  2460. <summary>
  2461. Creates a new instance from a protocol-buffer stream that has a length-prefix
  2462. on data (to assist with network IO).
  2463. </summary>
  2464. <typeparam name="T">The type to be created.</typeparam>
  2465. <param name="source">The binary stream to apply to the new instance (cannot be null).</param>
  2466. <param name="style">How to encode the length prefix.</param>
  2467. <returns>A new, initialized instance.</returns>
  2468. </member>
  2469. <member name="M:ProtoBuf.Serializer.DeserializeWithLengthPrefix``1(System.IO.Stream,ProtoBuf.PrefixStyle,System.Int32)">
  2470. <summary>
  2471. Creates a new instance from a protocol-buffer stream that has a length-prefix
  2472. on data (to assist with network IO).
  2473. </summary>
  2474. <typeparam name="T">The type to be created.</typeparam>
  2475. <param name="source">The binary stream to apply to the new instance (cannot be null).</param>
  2476. <param name="style">How to encode the length prefix.</param>
  2477. <param name="fieldNumber">The expected tag of the item (only used with base-128 prefix style).</param>
  2478. <returns>A new, initialized instance.</returns>
  2479. </member>
  2480. <member name="M:ProtoBuf.Serializer.MergeWithLengthPrefix``1(System.IO.Stream,``0,ProtoBuf.PrefixStyle)">
  2481. <summary>
  2482. Applies a protocol-buffer stream to an existing instance, using length-prefixed
  2483. data - useful with network IO.
  2484. </summary>
  2485. <typeparam name="T">The type being merged.</typeparam>
  2486. <param name="instance">The existing instance to be modified (can be null).</param>
  2487. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  2488. <param name="style">How to encode the length prefix.</param>
  2489. <returns>The updated instance; this may be different to the instance argument if
  2490. either the original instance was null, or the stream defines a known sub-type of the
  2491. original instance.</returns>
  2492. </member>
  2493. <member name="M:ProtoBuf.Serializer.SerializeWithLengthPrefix``1(System.IO.Stream,``0,ProtoBuf.PrefixStyle)">
  2494. <summary>
  2495. Writes a protocol-buffer representation of the given instance to the supplied stream,
  2496. with a length-prefix. This is useful for socket programming,
  2497. as DeserializeWithLengthPrefix/MergeWithLengthPrefix can be used to read the single object back
  2498. from an ongoing stream.
  2499. </summary>
  2500. <typeparam name="T">The type being serialized.</typeparam>
  2501. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  2502. <param name="style">How to encode the length prefix.</param>
  2503. <param name="destination">The destination stream to write to.</param>
  2504. </member>
  2505. <member name="M:ProtoBuf.Serializer.SerializeWithLengthPrefix``1(System.IO.Stream,``0,ProtoBuf.PrefixStyle,System.Int32)">
  2506. <summary>
  2507. Writes a protocol-buffer representation of the given instance to the supplied stream,
  2508. with a length-prefix. This is useful for socket programming,
  2509. as DeserializeWithLengthPrefix/MergeWithLengthPrefix can be used to read the single object back
  2510. from an ongoing stream.
  2511. </summary>
  2512. <typeparam name="T">The type being serialized.</typeparam>
  2513. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  2514. <param name="style">How to encode the length prefix.</param>
  2515. <param name="destination">The destination stream to write to.</param>
  2516. <param name="fieldNumber">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
  2517. </member>
  2518. <member name="M:ProtoBuf.Serializer.TryReadLengthPrefix(System.IO.Stream,ProtoBuf.PrefixStyle,System.Int32@)">
  2519. <summary>Indicates the number of bytes expected for the next message.</summary>
  2520. <param name="source">The stream containing the data to investigate for a length.</param>
  2521. <param name="style">The algorithm used to encode the length.</param>
  2522. <param name="length">The length of the message, if it could be identified.</param>
  2523. <returns>True if a length could be obtained, false otherwise.</returns>
  2524. </member>
  2525. <member name="M:ProtoBuf.Serializer.TryReadLengthPrefix(System.Byte[],System.Int32,System.Int32,ProtoBuf.PrefixStyle,System.Int32@)">
  2526. <summary>Indicates the number of bytes expected for the next message.</summary>
  2527. <param name="buffer">The buffer containing the data to investigate for a length.</param>
  2528. <param name="index">The offset of the first byte to read from the buffer.</param>
  2529. <param name="count">The number of bytes to read from the buffer.</param>
  2530. <param name="style">The algorithm used to encode the length.</param>
  2531. <param name="length">The length of the message, if it could be identified.</param>
  2532. <returns>True if a length could be obtained, false otherwise.</returns>
  2533. </member>
  2534. <member name="M:ProtoBuf.Serializer.FlushPool">
  2535. <summary>
  2536. Releases any internal buffers that have been reserved for efficiency; this does not affect any serialization
  2537. operations; simply: it can be used (optionally) to release the buffers for garbage collection (at the expense
  2538. of having to re-allocate a new buffer for the next operation, rather than re-use prior buffers).
  2539. </summary>
  2540. </member>
  2541. <member name="T:ProtoBuf.Serializer.NonGeneric">
  2542. <summary>
  2543. Provides non-generic access to the default serializer.
  2544. </summary>
  2545. </member>
  2546. <member name="M:ProtoBuf.Serializer.NonGeneric.DeepClone(System.Object)">
  2547. <summary>
  2548. Create a deep clone of the supplied instance; any sub-items are also cloned.
  2549. </summary>
  2550. </member>
  2551. <member name="M:ProtoBuf.Serializer.NonGeneric.Serialize(System.IO.Stream,System.Object)">
  2552. <summary>
  2553. Writes a protocol-buffer representation of the given instance to the supplied stream.
  2554. </summary>
  2555. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  2556. <param name="dest">The destination stream to write to.</param>
  2557. </member>
  2558. <member name="M:ProtoBuf.Serializer.NonGeneric.Deserialize(System.Type,System.IO.Stream)">
  2559. <summary>
  2560. Creates a new instance from a protocol-buffer stream
  2561. </summary>
  2562. <param name="type">The type to be created.</param>
  2563. <param name="source">The binary stream to apply to the new instance (cannot be null).</param>
  2564. <returns>A new, initialized instance.</returns>
  2565. </member>
  2566. <member name="M:ProtoBuf.Serializer.NonGeneric.Merge(System.IO.Stream,System.Object)">
  2567. <summary>Applies a protocol-buffer stream to an existing instance.</summary>
  2568. <param name="instance">The existing instance to be modified (cannot be null).</param>
  2569. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  2570. <returns>The updated instance</returns>
  2571. </member>
  2572. <member name="M:ProtoBuf.Serializer.NonGeneric.SerializeWithLengthPrefix(System.IO.Stream,System.Object,ProtoBuf.PrefixStyle,System.Int32)">
  2573. <summary>
  2574. Writes a protocol-buffer representation of the given instance to the supplied stream,
  2575. with a length-prefix. This is useful for socket programming,
  2576. as DeserializeWithLengthPrefix/MergeWithLengthPrefix can be used to read the single object back
  2577. from an ongoing stream.
  2578. </summary>
  2579. <param name="instance">The existing instance to be serialized (cannot be null).</param>
  2580. <param name="style">How to encode the length prefix.</param>
  2581. <param name="destination">The destination stream to write to.</param>
  2582. <param name="fieldNumber">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
  2583. </member>
  2584. <member name="M:ProtoBuf.Serializer.NonGeneric.TryDeserializeWithLengthPrefix(System.IO.Stream,ProtoBuf.PrefixStyle,ProtoBuf.Serializer.TypeResolver,System.Object@)">
  2585. <summary>
  2586. Applies a protocol-buffer stream to an existing instance (or null), using length-prefixed
  2587. data - useful with network IO.
  2588. </summary>
  2589. <param name="value">The existing instance to be modified (can be null).</param>
  2590. <param name="source">The binary stream to apply to the instance (cannot be null).</param>
  2591. <param name="style">How to encode the length prefix.</param>
  2592. <param name="resolver">Used to resolve types on a per-field basis.</param>
  2593. <returns>The updated instance; this may be different to the instance argument if
  2594. either the original instance was null, or the stream defines a known sub-type of the
  2595. original instance.</returns>
  2596. </member>
  2597. <member name="M:ProtoBuf.Serializer.NonGeneric.CanSerialize(System.Type)">
  2598. <summary>
  2599. Indicates whether the supplied type is explicitly modelled by the model
  2600. </summary>
  2601. </member>
  2602. <member name="T:ProtoBuf.Serializer.GlobalOptions">
  2603. <summary>
  2604. Global switches that change the behavior of protobuf-net
  2605. </summary>
  2606. </member>
  2607. <member name="P:ProtoBuf.Serializer.GlobalOptions.InferTagFromName">
  2608. <summary>
  2609. <see cref="P:ProtoBuf.Meta.RuntimeTypeModel.InferTagFromNameDefault"/>
  2610. </summary>
  2611. </member>
  2612. <member name="T:ProtoBuf.Serializer.TypeResolver">
  2613. <summary>
  2614. Maps a field-number to a type
  2615. </summary>
  2616. </member>
  2617. <member name="M:ProtoBuf.Serializers.IProtoSerializer.Write(System.Object,ProtoBuf.ProtoWriter)">
  2618. <summary>
  2619. Perform the steps necessary to serialize this data.
  2620. </summary>
  2621. <param name="value">The value to be serialized.</param>
  2622. <param name="dest">The writer entity that is accumulating the output data.</param>
  2623. </member>
  2624. <member name="M:ProtoBuf.Serializers.IProtoSerializer.Read(System.Object,ProtoBuf.ProtoReader)">
  2625. <summary>
  2626. Perform the steps necessary to deserialize this data.
  2627. </summary>
  2628. <param name="value">The current value, if appropriate.</param>
  2629. <param name="source">The reader providing the input data.</param>
  2630. <returns>The updated / replacement value.</returns>
  2631. </member>
  2632. <member name="M:ProtoBuf.Serializers.IProtoSerializer.EmitWrite(ProtoBuf.Compiler.CompilerContext,ProtoBuf.Compiler.Local)">
  2633. <summary>Emit the IL necessary to perform the given actions
  2634. to serialize this data.
  2635. </summary>
  2636. <param name="ctx">Details and utilities for the method being generated.</param>
  2637. <param name="valueFrom">The source of the data to work against;
  2638. If the value is only needed once, then LoadValue is sufficient. If
  2639. the value is needed multiple times, then note that a "null"
  2640. means "the top of the stack", in which case you should create your
  2641. own copy - GetLocalWithValue.</param>
  2642. </member>
  2643. <member name="M:ProtoBuf.Serializers.IProtoSerializer.EmitRead(ProtoBuf.Compiler.CompilerContext,ProtoBuf.Compiler.Local)">
  2644. <summary>
  2645. Emit the IL necessary to perform the given actions to deserialize this data.
  2646. </summary>
  2647. <param name="ctx">Details and utilities for the method being generated.</param>
  2648. <param name="entity">For nested values, the instance holding the values; note
  2649. that this is not always provided - a null means not supplied. Since this is always
  2650. a variable or argument, it is not necessary to consume this value.</param>
  2651. </member>
  2652. <member name="P:ProtoBuf.Serializers.IProtoSerializer.ExpectedType">
  2653. <summary>
  2654. The type that this serializer is intended to work for.
  2655. </summary>
  2656. </member>
  2657. <member name="P:ProtoBuf.Serializers.IProtoSerializer.RequiresOldValue">
  2658. <summary>
  2659. Indicates whether a Read operation <em>replaces</em> the existing value, or
  2660. <em>extends</em> the value. If false, the "value" parameter to Read is
  2661. discarded, and should be passed in as null.
  2662. </summary>
  2663. </member>
  2664. <member name="P:ProtoBuf.Serializers.IProtoSerializer.ReturnsValue">
  2665. <summary>
  2666. Now all Read operations return a value (although most do); if false no
  2667. value should be expected.
  2668. </summary>
  2669. </member>
  2670. <member name="T:ProtoBuf.ServiceModel.ProtoBehaviorAttribute">
  2671. <summary>
  2672. Uses protocol buffer serialization on the specified operation; note that this
  2673. must be enabled on both the client and server.
  2674. </summary>
  2675. </member>
  2676. <member name="T:ProtoBuf.ServiceModel.ProtoBehaviorExtension">
  2677. <summary>
  2678. Configuration element to swap out DatatContractSerilaizer with the XmlProtoSerializer for a given endpoint.
  2679. </summary>
  2680. <seealso cref="T:ProtoBuf.ServiceModel.ProtoEndpointBehavior"/>
  2681. </member>
  2682. <member name="M:ProtoBuf.ServiceModel.ProtoBehaviorExtension.#ctor">
  2683. <summary>
  2684. Creates a new ProtoBehaviorExtension instance.
  2685. </summary>
  2686. </member>
  2687. <member name="M:ProtoBuf.ServiceModel.ProtoBehaviorExtension.CreateBehavior">
  2688. <summary>
  2689. Creates a behavior extension based on the current configuration settings.
  2690. </summary>
  2691. <returns>The behavior extension.</returns>
  2692. </member>
  2693. <member name="P:ProtoBuf.ServiceModel.ProtoBehaviorExtension.BehaviorType">
  2694. <summary>
  2695. Gets the type of behavior.
  2696. </summary>
  2697. </member>
  2698. <member name="T:ProtoBuf.ServiceModel.ProtoEndpointBehavior">
  2699. <summary>
  2700. Behavior to swap out DatatContractSerilaizer with the XmlProtoSerializer for a given endpoint.
  2701. <example>
  2702. Add the following to the server and client app.config in the system.serviceModel section:
  2703. <behaviors>
  2704. <endpointBehaviors>
  2705. <behavior name="ProtoBufBehaviorConfig">
  2706. <ProtoBufSerialization/>
  2707. </behavior>
  2708. </endpointBehaviors>
  2709. </behaviors>
  2710. <extensions>
  2711. <behaviorExtensions>
  2712. <add name="ProtoBufSerialization" type="ProtoBuf.ServiceModel.ProtoBehaviorExtension, protobuf-net, Version=1.0.0.255, Culture=neutral, PublicKeyToken=257b51d87d2e4d67"/>
  2713. </behaviorExtensions>
  2714. </extensions>
  2715. Configure your endpoints to have a behaviorConfiguration as follows:
  2716. <service name="TK.Framework.Samples.ServiceModel.Contract.SampleService">
  2717. <endpoint address="http://myhost:9003/SampleService" binding="basicHttpBinding" behaviorConfiguration="ProtoBufBehaviorConfig"
  2718. bindingConfiguration="basicHttpBindingConfig" name="basicHttpProtoBuf" contract="ISampleServiceContract" />
  2719. </service>
  2720. <client>
  2721. <endpoint address="http://myhost:9003/SampleService" binding="basicHttpBinding"
  2722. bindingConfiguration="basicHttpBindingConfig" contract="ISampleServiceContract"
  2723. name="BasicHttpProtoBufEndpoint" behaviorConfiguration="ProtoBufBehaviorConfig"/>
  2724. </client>
  2725. </example>
  2726. </summary>
  2727. </member>
  2728. <member name="T:ProtoBuf.ServiceModel.ProtoOperationBehavior">
  2729. <summary>
  2730. Describes a WCF operation behaviour that can perform protobuf serialization
  2731. </summary>
  2732. </member>
  2733. <member name="M:ProtoBuf.ServiceModel.ProtoOperationBehavior.#ctor(System.ServiceModel.Description.OperationDescription)">
  2734. <summary>
  2735. Create a new ProtoOperationBehavior instance
  2736. </summary>
  2737. </member>
  2738. <member name="M:ProtoBuf.ServiceModel.ProtoOperationBehavior.CreateSerializer(System.Type,System.Xml.XmlDictionaryString,System.Xml.XmlDictionaryString,System.Collections.Generic.IList{System.Type})">
  2739. <summary>
  2740. Creates a protobuf serializer if possible (falling back to the default WCF serializer)
  2741. </summary>
  2742. </member>
  2743. <member name="P:ProtoBuf.ServiceModel.ProtoOperationBehavior.Model">
  2744. <summary>
  2745. The type-model that should be used with this behaviour
  2746. </summary>
  2747. </member>
  2748. <member name="T:ProtoBuf.ServiceModel.XmlProtoSerializer">
  2749. <summary>
  2750. An xml object serializer that can embed protobuf data in a base-64 hunk (looking like a byte[])
  2751. </summary>
  2752. </member>
  2753. <member name="M:ProtoBuf.ServiceModel.XmlProtoSerializer.TryCreate(ProtoBuf.Meta.TypeModel,System.Type)">
  2754. <summary>
  2755. Attempt to create a new serializer for the given model and type
  2756. </summary>
  2757. <returns>A new serializer instance if the type is recognised by the model; null otherwise</returns>
  2758. </member>
  2759. <member name="M:ProtoBuf.ServiceModel.XmlProtoSerializer.#ctor(ProtoBuf.Meta.TypeModel,System.Type)">
  2760. <summary>
  2761. Creates a new serializer for the given model and type
  2762. </summary>
  2763. </member>
  2764. <member name="M:ProtoBuf.ServiceModel.XmlProtoSerializer.WriteEndObject(System.Xml.XmlDictionaryWriter)">
  2765. <summary>
  2766. Ends an object in the output
  2767. </summary>
  2768. </member>
  2769. <member name="M:ProtoBuf.ServiceModel.XmlProtoSerializer.WriteStartObject(System.Xml.XmlDictionaryWriter,System.Object)">
  2770. <summary>
  2771. Begins an object in the output
  2772. </summary>
  2773. </member>
  2774. <member name="M:ProtoBuf.ServiceModel.XmlProtoSerializer.WriteObjectContent(System.Xml.XmlDictionaryWriter,System.Object)">
  2775. <summary>
  2776. Writes the body of an object in the output
  2777. </summary>
  2778. </member>
  2779. <member name="M:ProtoBuf.ServiceModel.XmlProtoSerializer.IsStartObject(System.Xml.XmlDictionaryReader)">
  2780. <summary>
  2781. Indicates whether this is the start of an object we are prepared to handle
  2782. </summary>
  2783. </member>
  2784. <member name="M:ProtoBuf.ServiceModel.XmlProtoSerializer.ReadObject(System.Xml.XmlDictionaryReader,System.Boolean)">
  2785. <summary>
  2786. Reads the body of an object
  2787. </summary>
  2788. </member>
  2789. <member name="T:ProtoBuf.SubItemToken">
  2790. <summary>
  2791. Used to hold particulars relating to nested objects. This is opaque to the caller - simply
  2792. give back the token you are given at the end of an object.
  2793. </summary>
  2794. </member>
  2795. <member name="T:ProtoBuf.WireType">
  2796. <summary>
  2797. Indicates the encoding used to represent an individual value in a protobuf stream
  2798. </summary>
  2799. </member>
  2800. <member name="F:ProtoBuf.WireType.None">
  2801. <summary>
  2802. Represents an error condition
  2803. </summary>
  2804. </member>
  2805. <member name="F:ProtoBuf.WireType.Variant">
  2806. <summary>
  2807. Base-128 variant-length encoding
  2808. </summary>
  2809. </member>
  2810. <member name="F:ProtoBuf.WireType.Fixed64">
  2811. <summary>
  2812. Fixed-length 8-byte encoding
  2813. </summary>
  2814. </member>
  2815. <member name="F:ProtoBuf.WireType.String">
  2816. <summary>
  2817. Length-variant-prefixed encoding
  2818. </summary>
  2819. </member>
  2820. <member name="F:ProtoBuf.WireType.StartGroup">
  2821. <summary>
  2822. Indicates the start of a group
  2823. </summary>
  2824. </member>
  2825. <member name="F:ProtoBuf.WireType.EndGroup">
  2826. <summary>
  2827. Indicates the end of a group
  2828. </summary>
  2829. </member>
  2830. <member name="F:ProtoBuf.WireType.Fixed32">
  2831. <summary>
  2832. Fixed-length 4-byte encoding
  2833. </summary>10
  2834. </member>
  2835. <member name="F:ProtoBuf.WireType.SignedVariant">
  2836. <summary>
  2837. This is not a formal wire-type in the "protocol buffers" spec, but
  2838. denotes a variant integer that should be interpreted using
  2839. zig-zag semantics (so -ve numbers aren't a significant overhead)
  2840. </summary>
  2841. </member>
  2842. </members>
  2843. </doc>