選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。
 
 
 
 
 
 

1401 行
70 KiB

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>ServiceStack.Text</name>
  5. </assembly>
  6. <members>
  7. <member name="T:ServiceStack.Text.AssemblyUtils">
  8. <summary>
  9. Utils to load types
  10. </summary>
  11. </member>
  12. <member name="M:ServiceStack.Text.AssemblyUtils.FindType(System.String)">
  13. <summary>
  14. Find the type from the name supplied
  15. </summary>
  16. <param name="typeName">[typeName] or [typeName, assemblyName]</param>
  17. <returns></returns>
  18. </member>
  19. <member name="M:ServiceStack.Text.AssemblyUtils.MainInterface``1">
  20. <summary>
  21. The top-most interface of the given type, if any.
  22. </summary>
  23. </member>
  24. <member name="M:ServiceStack.Text.AssemblyUtils.FindType(System.String,System.String)">
  25. <summary>
  26. Find type if it exists
  27. </summary>
  28. <param name="typeName"></param>
  29. <param name="assemblyName"></param>
  30. <returns>The type if it exists</returns>
  31. </member>
  32. <member name="M:ServiceStack.Text.Common.DateTimeSerializer.Prepare(System.DateTime,System.Boolean)">
  33. <summary>
  34. If AlwaysUseUtc is set to true then convert all DateTime to UTC. If PreserveUtc is set to true then UTC dates will not convert to local
  35. </summary>
  36. <param name="dateTime"></param>
  37. <returns></returns>
  38. </member>
  39. <member name="M:ServiceStack.Text.Common.DateTimeSerializer.RepairXsdTimeSeparator(System.String)">
  40. <summary>
  41. Repairs an out-of-spec XML date/time string which incorrectly uses a space instead of a 'T' to separate the date from the time.
  42. These string are occasionally generated by SQLite and can cause errors in OrmLite when reading these columns from the DB.
  43. </summary>
  44. <param name="dateTimeStr">The XML date/time string to repair</param>
  45. <returns>The repaired string. If no repairs were made, the original string is returned.</returns>
  46. </member>
  47. <member name="M:ServiceStack.Text.Common.DateTimeSerializer.ParseWcfJsonDateOffset(System.String)">
  48. <summary>
  49. WCF Json format: /Date(unixts+0000)/
  50. </summary>
  51. <param name="wcfJsonDate"></param>
  52. <returns></returns>
  53. </member>
  54. <member name="M:ServiceStack.Text.Common.DateTimeSerializer.ParseWcfJsonDate(System.String)">
  55. <summary>
  56. WCF Json format: /Date(unixts+0000)/
  57. </summary>
  58. <param name="wcfJsonDate"></param>
  59. <returns></returns>
  60. </member>
  61. <member name="M:ServiceStack.Text.Common.DeserializeTypeUtils.GetTypeStringConstructor(System.Type)">
  62. <summary>
  63. Get the type(string) constructor if exists
  64. </summary>
  65. <param name="type">The type.</param>
  66. <returns></returns>
  67. </member>
  68. <member name="M:ServiceStack.Text.Common.JsWriter.HasAnyEscapeChars(System.String)">
  69. <summary>
  70. micro optimizations: using flags instead of value.IndexOfAny(EscapeChars)
  71. </summary>
  72. <param name="value"></param>
  73. <returns></returns>
  74. </member>
  75. <member name="T:ServiceStack.Text.Controller.PathInfo">
  76. <summary>
  77. Class to hold
  78. </summary>
  79. </member>
  80. <!-- Badly formed XML comment ignored for member "M:ServiceStack.Text.Controller.PathInfo.Parse(System.String)" -->
  81. <member name="T:ServiceStack.Text.DateTimeExtensions">
  82. <summary>
  83. A fast, standards-based, serialization-issue free DateTime serailizer.
  84. </summary>
  85. </member>
  86. <member name="M:ServiceStack.Text.ITypeSerializer`1.CanCreateFromString(System.Type)">
  87. <summary>
  88. Determines whether this serializer can create the specified type from a string.
  89. </summary>
  90. <param name="type">The type.</param>
  91. <returns>
  92. <c>true</c> if this instance [can create from string] the specified type; otherwise, <c>false</c>.
  93. </returns>
  94. </member>
  95. <member name="M:ServiceStack.Text.ITypeSerializer`1.DeserializeFromString(System.String)">
  96. <summary>
  97. Parses the specified value.
  98. </summary>
  99. <param name="value">The value.</param>
  100. <returns></returns>
  101. </member>
  102. <member name="M:ServiceStack.Text.ITypeSerializer`1.DeserializeFromReader(System.IO.TextReader)">
  103. <summary>
  104. Deserializes from reader.
  105. </summary>
  106. <param name="reader">The reader.</param>
  107. <returns></returns>
  108. </member>
  109. <member name="M:ServiceStack.Text.ITypeSerializer`1.SerializeToString(`0)">
  110. <summary>
  111. Serializes to string.
  112. </summary>
  113. <param name="value">The value.</param>
  114. <returns></returns>
  115. </member>
  116. <member name="M:ServiceStack.Text.ITypeSerializer`1.SerializeToWriter(`0,System.IO.TextWriter)">
  117. <summary>
  118. Serializes to writer.
  119. </summary>
  120. <param name="value">The value.</param>
  121. <param name="writer">The writer.</param>
  122. </member>
  123. <member name="F:ServiceStack.Text.JsConfig.sTimeSpanHandler">
  124. <summary>
  125. Sets which format to use when serializing TimeSpans
  126. </summary>
  127. </member>
  128. <member name="F:ServiceStack.Text.JsConfig.sEmitCamelCaseNames">
  129. <summary>
  130. <see langword="true"/> if the <see cref="T:ServiceStack.Text.Common.ITypeSerializer"/> is configured
  131. to take advantage of <see cref="T:System.CLSCompliantAttribute"/> specification,
  132. to support user-friendly serialized formats, ie emitting camelCasing for JSON
  133. and parsing member names and enum values in a case-insensitive manner.
  134. </summary>
  135. </member>
  136. <member name="F:ServiceStack.Text.JsConfig.sEmitLowercaseUnderscoreNames">
  137. <summary>
  138. <see langword="true"/> if the <see cref="T:ServiceStack.Text.Common.ITypeSerializer"/> is configured
  139. to support web-friendly serialized formats, ie emitting lowercase_underscore_casing for JSON
  140. </summary>
  141. </member>
  142. <member name="F:ServiceStack.Text.JsConfig.sPropertyConvention">
  143. <summary>
  144. Define how property names are mapped during deserialization
  145. </summary>
  146. </member>
  147. <member name="F:ServiceStack.Text.JsConfig.sThrowOnDeserializationError">
  148. <summary>
  149. Gets or sets a value indicating if the framework should throw serialization exceptions
  150. or continue regardless of deserialization errors. If <see langword="true"/> the framework
  151. will throw; otherwise, it will parse as many fields as possible. The default is <see langword="false"/>.
  152. </summary>
  153. </member>
  154. <member name="F:ServiceStack.Text.JsConfig.sAlwaysUseUtc">
  155. <summary>
  156. Gets or sets a value indicating if the framework should always convert <see cref="T:System.DateTime"/> to UTC format instead of local time.
  157. </summary>
  158. </member>
  159. <member name="F:ServiceStack.Text.JsConfig.sSkipDateTimeConversion">
  160. <summary>
  161. Gets or sets a value indicating if the framework should skip automatic <see cref="T:System.DateTime"/> conversions.
  162. Dates will be handled literally, any included timezone encoding will be lost and the date will be treaded as DateTimeKind.Local
  163. Utc formatted input will result in DateTimeKind.Utc output. Any input without TZ data will be set DateTimeKind.Unspecified
  164. This will take precedence over other flags like AlwaysUseUtc
  165. JsConfig.DateHandler = DateHandler.ISO8601 should be used when set true for consistent de/serialization.
  166. </summary>
  167. </member>
  168. <member name="F:ServiceStack.Text.JsConfig.sAssumeUtc">
  169. <summary>
  170. Gets or sets a value indicating if the framework should always assume <see cref="T:System.DateTime"/> is in UTC format if Kind is Unspecified.
  171. </summary>
  172. </member>
  173. <member name="F:ServiceStack.Text.JsConfig.sAppendUtcOffset">
  174. <summary>
  175. Gets or sets whether we should append the Utc offset when we serialize Utc dates. Defaults to no.
  176. Only supported for when the JsConfig.DateHandler == JsonDateHandler.TimestampOffset
  177. </summary>
  178. </member>
  179. <member name="F:ServiceStack.Text.JsConfig.sEscapeUnicode">
  180. <summary>
  181. Gets or sets a value indicating if unicode symbols should be serialized as "\uXXXX".
  182. </summary>
  183. </member>
  184. <member name="F:ServiceStack.Text.JsConfig.sOnDeserializationError">
  185. <summary>
  186. Gets or sets a value indicating if the framework should call an error handler when
  187. an exception happens during the deserialization.
  188. </summary>
  189. <remarks>Parameters have following meaning in order: deserialized entity, property name, parsed value, property type, caught exception.</remarks>
  190. </member>
  191. <member name="P:ServiceStack.Text.JsConfig.PreferInterfaces">
  192. <summary>
  193. If set to true, Interface types will be prefered over concrete types when serializing.
  194. </summary>
  195. </member>
  196. <member name="F:ServiceStack.Text.JsConfig.sIncludePublicFields">
  197. <summary>
  198. If set to true, Interface types will be prefered over concrete types when serializing.
  199. </summary>
  200. </member>
  201. <member name="F:ServiceStack.Text.JsConfig.sMaxDepth">
  202. <summary>
  203. Sets the maximum depth to avoid circular dependencies
  204. </summary>
  205. </member>
  206. <member name="F:ServiceStack.Text.JsConfig.sModelFactory">
  207. <summary>
  208. Set this to enable your own type construction provider.
  209. This is helpful for integration with IoC containers where you need to call the container constructor.
  210. Return null if you don't know how to construct the type and the parameterless constructor will be used.
  211. </summary>
  212. </member>
  213. <member name="F:ServiceStack.Text.JsConfig`1.IncludeTypeInfo">
  214. <summary>
  215. Always emit type info for this type. Takes precedence over ExcludeTypeInfo
  216. </summary>
  217. </member>
  218. <member name="F:ServiceStack.Text.JsConfig`1.ExcludeTypeInfo">
  219. <summary>
  220. Never emit type info for this type
  221. </summary>
  222. </member>
  223. <member name="F:ServiceStack.Text.JsConfig`1.EmitCamelCaseNames">
  224. <summary>
  225. <see langword="true"/> if the <see cref="T:ServiceStack.Text.Common.ITypeSerializer"/> is configured
  226. to take advantage of <see cref="T:System.CLSCompliantAttribute"/> specification,
  227. to support user-friendly serialized formats, ie emitting camelCasing for JSON
  228. and parsing member names and enum values in a case-insensitive manner.
  229. </summary>
  230. </member>
  231. <member name="F:ServiceStack.Text.JsConfig`1.serializeFn">
  232. <summary>
  233. Define custom serialization fn for BCL Structs
  234. </summary>
  235. </member>
  236. <member name="P:ServiceStack.Text.JsConfig`1.TreatValueAsRefType">
  237. <summary>
  238. Opt-in flag to set some Value Types to be treated as a Ref Type
  239. </summary>
  240. </member>
  241. <member name="P:ServiceStack.Text.JsConfig`1.HasSerializeFn">
  242. <summary>
  243. Whether there is a fn (raw or otherwise)
  244. </summary>
  245. </member>
  246. <member name="F:ServiceStack.Text.JsConfig`1.rawSerializeFn">
  247. <summary>
  248. Define custom raw serialization fn
  249. </summary>
  250. </member>
  251. <member name="F:ServiceStack.Text.JsConfig`1.onSerializingFn">
  252. <summary>
  253. Define custom serialization hook
  254. </summary>
  255. </member>
  256. <member name="F:ServiceStack.Text.JsConfig`1.onSerializedFn">
  257. <summary>
  258. Define custom after serialization hook
  259. </summary>
  260. </member>
  261. <member name="F:ServiceStack.Text.JsConfig`1.deSerializeFn">
  262. <summary>
  263. Define custom deserialization fn for BCL Structs
  264. </summary>
  265. </member>
  266. <member name="F:ServiceStack.Text.JsConfig`1.rawDeserializeFn">
  267. <summary>
  268. Define custom raw deserialization fn for objects
  269. </summary>
  270. </member>
  271. <member name="F:ServiceStack.Text.JsConfig`1.ExcludePropertyNames">
  272. <summary>
  273. Exclude specific properties of this type from being serialized
  274. </summary>
  275. </member>
  276. <member name="F:ServiceStack.Text.PropertyConvention.Strict">
  277. <summary>
  278. The property names on target types must match property names in the JSON source
  279. </summary>
  280. </member>
  281. <member name="F:ServiceStack.Text.PropertyConvention.Lenient">
  282. <summary>
  283. The property names on target types may not match the property names in the JSON source
  284. </summary>
  285. </member>
  286. <member name="F:ServiceStack.Text.TimeSpanHandler.DurationFormat">
  287. <summary>
  288. Uses the xsd format like PT15H10M20S
  289. </summary>
  290. </member>
  291. <member name="F:ServiceStack.Text.TimeSpanHandler.StandardFormat">
  292. <summary>
  293. Uses the standard .net ToString method of the TimeSpan class
  294. </summary>
  295. </member>
  296. <member name="M:ServiceStack.Text.JsonExtensions.Get``1(System.Collections.Generic.Dictionary{System.String,System.String},System.String)">
  297. <summary>
  298. Get JSON string value converted to T
  299. </summary>
  300. </member>
  301. <member name="M:ServiceStack.Text.JsonExtensions.Get(System.Collections.Generic.Dictionary{System.String,System.String},System.String)">
  302. <summary>
  303. Get JSON string value
  304. </summary>
  305. </member>
  306. <member name="P:ServiceStack.Text.JsonObject.Item(System.String)">
  307. <summary>
  308. Get JSON string value
  309. </summary>
  310. </member>
  311. <member name="M:ServiceStack.Text.JsonObject.GetUnescaped(System.String)">
  312. <summary>
  313. Get unescaped string value
  314. </summary>
  315. </member>
  316. <member name="M:ServiceStack.Text.JsonObject.Child(System.String)">
  317. <summary>
  318. Get unescaped string value
  319. </summary>
  320. </member>
  321. <member name="M:ServiceStack.Text.JsonObject.WriteValue(System.IO.TextWriter,System.Object)">
  322. <summary>
  323. Write JSON Array, Object, bool or number values as raw string
  324. </summary>
  325. </member>
  326. <member name="T:ServiceStack.Text.JsonSerializer">
  327. <summary>
  328. Creates an instance of a Type from a string value
  329. </summary>
  330. </member>
  331. <member name="M:ServiceStack.Text.JsonSerializer`1.DeserializeFromString(System.String)">
  332. <summary>
  333. Parses the specified value.
  334. </summary>
  335. <param name="value">The value.</param>
  336. <returns></returns>
  337. </member>
  338. <member name="M:ServiceStack.Text.Json.JsonTypeSerializer.WriteRawString(System.IO.TextWriter,System.String)">
  339. <summary>
  340. Shortcut escape when we're sure value doesn't contain any escaped chars
  341. </summary>
  342. <param name="writer"></param>
  343. <param name="value"></param>
  344. </member>
  345. <member name="M:ServiceStack.Text.Json.JsonTypeSerializer.ConvertFromUtf32(System.Int32)">
  346. <summary>
  347. Given a character as utf32, returns the equivalent string provided that the character
  348. is legal json.
  349. </summary>
  350. <param name="utf32"></param>
  351. <returns></returns>
  352. </member>
  353. <member name="F:ServiceStack.Text.Json.JsonUtils.EscapedBackslash">
  354. <summary>
  355. Micro-optimization keep pre-built char arrays saving a .ToCharArray() + function call (see .net implementation of .Write(string))
  356. </summary>
  357. </member>
  358. <member name="M:ServiceStack.Text.Json.JsonUtils.HasAnyEscapeChars(System.String)">
  359. <summary>
  360. Searches the string for one or more non-printable characters.
  361. </summary>
  362. <param name="value">The string to search.</param>
  363. <returns>True if there are any characters that require escaping. False if the value can be written verbatim.</returns>
  364. <remarks>
  365. Micro optimizations: since quote and backslash are the only printable characters requiring escaping, removed previous optimization
  366. (using flags instead of value.IndexOfAny(EscapeChars)) in favor of two equality operations saving both memory and CPU time.
  367. Also slightly reduced code size by re-arranging conditions.
  368. TODO: Possible Linq-only solution requires profiling: return value.Any(c => !c.IsPrintable() || c == QuoteChar || c == EscapeChar);
  369. </remarks>
  370. </member>
  371. <member name="T:ServiceStack.Text.Json.JsonWriter`1">
  372. <summary>
  373. Implement the serializer using a more static approach
  374. </summary>
  375. <typeparam name="T"></typeparam>
  376. </member>
  377. <member name="T:ServiceStack.Text.Jsv.JsvWriter`1">
  378. <summary>
  379. Implement the serializer using a more static approach
  380. </summary>
  381. <typeparam name="T"></typeparam>
  382. </member>
  383. <member name="T:ServiceStack.Text.Marc.Link`2">
  384. <summary>
  385. Pretty Thread-Safe cache class from:
  386. http://code.google.com/p/dapper-dot-net/source/browse/Dapper/SqlMapper.cs
  387. This is a micro-cache; suitable when the number of terms is controllable (a few hundred, for example),
  388. and strictly append-only; you cannot change existing values. All key matches are on **REFERENCE**
  389. equality. The type is fully thread-safe.
  390. </summary>
  391. </member>
  392. <member name="T:ServiceStack.Text.FastMember.ObjectAccessor">
  393. <summary>
  394. Represents an individual object, allowing access to members by-name
  395. </summary>
  396. </member>
  397. <member name="P:ServiceStack.Text.FastMember.ObjectAccessor.Item(System.String)">
  398. <summary>
  399. Get or Set the value of a named member for the underlying object
  400. </summary>
  401. </member>
  402. <member name="P:ServiceStack.Text.FastMember.ObjectAccessor.Target">
  403. <summary>
  404. The object represented by this instance
  405. </summary>
  406. </member>
  407. <member name="M:ServiceStack.Text.FastMember.ObjectAccessor.Equals(System.Object)">
  408. <summary>
  409. Use the target types definition of equality
  410. </summary>
  411. </member>
  412. <member name="M:ServiceStack.Text.FastMember.ObjectAccessor.GetHashCode">
  413. <summary>
  414. Obtain the hash of the target object
  415. </summary>
  416. </member>
  417. <member name="M:ServiceStack.Text.FastMember.ObjectAccessor.ToString">
  418. <summary>
  419. Use the target's definition of a string representation
  420. </summary>
  421. </member>
  422. <member name="M:ServiceStack.Text.FastMember.ObjectAccessor.Create(System.Object)">
  423. <summary>
  424. Wraps an individual object, allowing by-name access to that instance
  425. </summary>
  426. </member>
  427. <member name="T:ServiceStack.Text.FastMember.TypeAccessor">
  428. <summary>
  429. Provides by-name member-access to objects of a given type
  430. </summary>
  431. </member>
  432. <member name="P:ServiceStack.Text.FastMember.TypeAccessor.CreateNewSupported">
  433. <summary>
  434. Does this type support new instances via a parameterless constructor?
  435. </summary>
  436. </member>
  437. <member name="M:ServiceStack.Text.FastMember.TypeAccessor.CreateNew">
  438. <summary>
  439. Create a new instance of this type
  440. </summary>
  441. </member>
  442. <member name="M:ServiceStack.Text.FastMember.TypeAccessor.Create(System.Type)">
  443. <summary>
  444. Provides a type-specific accessor, allowing by-name access for all objects of that type
  445. </summary>
  446. <remarks>The accessor is cached internally; a pre-existing accessor may be returned</remarks>
  447. </member>
  448. <member name="P:ServiceStack.Text.FastMember.TypeAccessor.Item(System.Object,System.String)">
  449. <summary>
  450. Get or set the value of a named member on the target instance
  451. </summary>
  452. </member>
  453. <member name="T:ServiceStack.Text.Pools.ObjectPool`1">
  454. <summary>
  455. Generic implementation of object pooling pattern with predefined pool size limit. The main
  456. purpose is that limited number of frequently used objects can be kept in the pool for
  457. further recycling.
  458. Notes:
  459. 1) it is not the goal to keep all returned objects. Pool is not meant for storage. If there
  460. is no space in the pool, extra returned objects will be dropped.
  461. 2) it is implied that if object was obtained from a pool, the caller will return it back in
  462. a relatively short time. Keeping checked out objects for long durations is ok, but
  463. reduces usefulness of pooling. Just new up your own.
  464. Not returning objects to the pool in not detrimental to the pool's work, but is a bad practice.
  465. Rationale:
  466. If there is no intent for reusing the object, do not use pool - just use "new".
  467. </summary>
  468. </member>
  469. <member name="T:ServiceStack.Text.Pools.ObjectPool`1.Factory">
  470. <remarks>
  471. Not using System.Func{T} because this file is linked into the (debugger) Formatter,
  472. which does not have that type (since it compiles against .NET 2.0).
  473. </remarks>
  474. </member>
  475. <member name="M:ServiceStack.Text.Pools.ObjectPool`1.Allocate">
  476. <summary>
  477. Produces an instance.
  478. </summary>
  479. <remarks>
  480. Search strategy is a simple linear probing which is chosen for it cache-friendliness.
  481. Note that Free will try to store recycled objects close to the start thus statistically
  482. reducing how far we will typically search.
  483. </remarks>
  484. </member>
  485. <member name="M:ServiceStack.Text.Pools.ObjectPool`1.Free(`0)">
  486. <summary>
  487. Returns objects to the pool.
  488. </summary>
  489. <remarks>
  490. Search strategy is a simple linear probing which is chosen for it cache-friendliness.
  491. Note that Free will try to store recycled objects close to the start thus statistically
  492. reducing how far we will typically search in Allocate.
  493. </remarks>
  494. </member>
  495. <member name="M:ServiceStack.Text.Pools.ObjectPool`1.ForgetTrackedObject(`0,`0)">
  496. <summary>
  497. Removes an object from leak tracking.
  498. This is called when an object is returned to the pool. It may also be explicitly
  499. called if an object allocated from the pool is intentionally not being returned
  500. to the pool. This can be of use with pooled arrays if the consumer wants to
  501. return a larger array to the pool than was originally allocated.
  502. </summary>
  503. </member>
  504. <member name="T:ServiceStack.Text.Pools.PooledObject`1">
  505. <summary>
  506. this is RAII object to automatically release pooled object when its owning pool
  507. </summary>
  508. </member>
  509. <member name="T:ServiceStack.Text.Pools.SharedPools">
  510. <summary>
  511. Shared object pool for roslyn
  512. Use this shared pool if only concern is reducing object allocations.
  513. if perf of an object pool itself is also a concern, use ObjectPool directly.
  514. For example, if you want to create a million of small objects within a second,
  515. use the ObjectPool directly. it should have much less overhead than using this.
  516. </summary>
  517. </member>
  518. <member name="M:ServiceStack.Text.Pools.SharedPools.BigDefault``1">
  519. <summary>
  520. pool that uses default constructor with 100 elements pooled
  521. </summary>
  522. </member>
  523. <member name="M:ServiceStack.Text.Pools.SharedPools.Default``1">
  524. <summary>
  525. pool that uses default constructor with 20 elements pooled
  526. </summary>
  527. </member>
  528. <member name="M:ServiceStack.Text.Pools.SharedPools.StringIgnoreCaseDictionary``1">
  529. <summary>
  530. pool that uses string as key with StringComparer.OrdinalIgnoreCase as key comparer
  531. </summary>
  532. </member>
  533. <member name="F:ServiceStack.Text.Pools.SharedPools.StringIgnoreCaseHashSet">
  534. <summary>
  535. pool that uses string as element with StringComparer.OrdinalIgnoreCase as element comparer
  536. </summary>
  537. </member>
  538. <member name="F:ServiceStack.Text.Pools.SharedPools.StringHashSet">
  539. <summary>
  540. pool that uses string as element with StringComparer.Ordinal as element comparer
  541. </summary>
  542. </member>
  543. <member name="F:ServiceStack.Text.Pools.SharedPools.ByteArray">
  544. <summary>
  545. Used to reduce the # of temporary byte[]s created to satisfy serialization and
  546. other I/O requests
  547. </summary>
  548. </member>
  549. <member name="F:ServiceStack.Text.Pools.SharedPools.ByteBufferSize">
  550. pooled memory : 4K * 512 = 4MB
  551. </member>
  552. <member name="T:ServiceStack.Text.StringBuilderCache">
  553. <summary>
  554. Reusable StringBuilder ThreadStatic Cache
  555. </summary>
  556. </member>
  557. <member name="T:ServiceStack.Text.StringBuilderCacheAlt">
  558. <summary>
  559. Alternative Reusable StringBuilder ThreadStatic Cache
  560. </summary>
  561. </member>
  562. <member name="T:ServiceStack.Text.StringWriterCache">
  563. <summary>
  564. Reusable StringWriter ThreadStatic Cache
  565. </summary>
  566. </member>
  567. <member name="T:ServiceStack.Text.StringWriterCacheAlt">
  568. <summary>
  569. Alternative Reusable StringWriter ThreadStatic Cache
  570. </summary>
  571. </member>
  572. <member name="T:ServiceStack.Text.RecyclableMemoryStreamManager">
  573. <summary>
  574. Manages pools of RecyclableMemoryStream objects.
  575. </summary>
  576. <remarks>
  577. There are two pools managed in here. The small pool contains same-sized buffers that are handed to streams
  578. as they write more data.
  579. For scenarios that need to call GetBuffer(), the large pool contains buffers of various sizes, all
  580. multiples of LargeBufferMultiple (1 MB by default). They are split by size to avoid overly-wasteful buffer
  581. usage. There should be far fewer 8 MB buffers than 1 MB buffers, for example.
  582. </remarks>
  583. </member>
  584. <member name="T:ServiceStack.Text.RecyclableMemoryStreamManager.EventHandler">
  585. <summary>
  586. Generic delegate for handling events without any arguments.
  587. </summary>
  588. </member>
  589. <member name="T:ServiceStack.Text.RecyclableMemoryStreamManager.LargeBufferDiscardedEventHandler">
  590. <summary>
  591. Delegate for handling large buffer discard reports.
  592. </summary>
  593. <param name="reason">Reason the buffer was discarded.</param>
  594. </member>
  595. <member name="T:ServiceStack.Text.RecyclableMemoryStreamManager.StreamLengthReportHandler">
  596. <summary>
  597. Delegate for handling reports of stream size when streams are allocated
  598. </summary>
  599. <param name="bytes">Bytes allocated.</param>
  600. </member>
  601. <member name="T:ServiceStack.Text.RecyclableMemoryStreamManager.UsageReportEventHandler">
  602. <summary>
  603. Delegate for handling periodic reporting of memory use statistics.
  604. </summary>
  605. <param name="smallPoolInUseBytes">Bytes currently in use in the small pool.</param>
  606. <param name="smallPoolFreeBytes">Bytes currently free in the small pool.</param>
  607. <param name="largePoolInUseBytes">Bytes currently in use in the large pool.</param>
  608. <param name="largePoolFreeBytes">Bytes currently free in the large pool.</param>
  609. </member>
  610. <member name="F:ServiceStack.Text.RecyclableMemoryStreamManager.largePools">
  611. <summary>
  612. pools[0] = 1x largeBufferMultiple buffers
  613. pools[1] = 2x largeBufferMultiple buffers
  614. etc., up to maximumBufferSize
  615. </summary>
  616. </member>
  617. <member name="M:ServiceStack.Text.RecyclableMemoryStreamManager.#ctor">
  618. <summary>
  619. Initializes the memory manager with the default block/buffer specifications.
  620. </summary>
  621. </member>
  622. <member name="M:ServiceStack.Text.RecyclableMemoryStreamManager.#ctor(System.Int32,System.Int32,System.Int32)">
  623. <summary>
  624. Initializes the memory manager with the given block requiredSize.
  625. </summary>
  626. <param name="blockSize">Size of each block that is pooled. Must be > 0.</param>
  627. <param name="largeBufferMultiple">Each large buffer will be a multiple of this value.</param>
  628. <param name="maximumBufferSize">Buffers larger than this are not pooled</param>
  629. <exception cref="T:System.ArgumentOutOfRangeException">blockSize is not a positive number, or largeBufferMultiple is not a positive number, or maximumBufferSize is less than blockSize.</exception>
  630. <exception cref="T:System.ArgumentException">maximumBufferSize is not a multiple of largeBufferMultiple</exception>
  631. </member>
  632. <member name="P:ServiceStack.Text.RecyclableMemoryStreamManager.BlockSize">
  633. <summary>
  634. The size of each block. It must be set at creation and cannot be changed.
  635. </summary>
  636. </member>
  637. <member name="P:ServiceStack.Text.RecyclableMemoryStreamManager.LargeBufferMultiple">
  638. <summary>
  639. All buffers are multiples of this number. It must be set at creation and cannot be changed.
  640. </summary>
  641. </member>
  642. <member name="P:ServiceStack.Text.RecyclableMemoryStreamManager.MaximumBufferSize">
  643. <summary>
  644. Gets or sets the maximum buffer size.
  645. </summary>
  646. <remarks>Any buffer that is returned to the pool that is larger than this will be
  647. discarded and garbage collected.</remarks>
  648. </member>
  649. <member name="P:ServiceStack.Text.RecyclableMemoryStreamManager.SmallPoolFreeSize">
  650. <summary>
  651. Number of bytes in small pool not currently in use
  652. </summary>
  653. </member>
  654. <member name="P:ServiceStack.Text.RecyclableMemoryStreamManager.SmallPoolInUseSize">
  655. <summary>
  656. Number of bytes currently in use by stream from the small pool
  657. </summary>
  658. </member>
  659. <member name="P:ServiceStack.Text.RecyclableMemoryStreamManager.LargePoolFreeSize">
  660. <summary>
  661. Number of bytes in large pool not currently in use
  662. </summary>
  663. </member>
  664. <member name="P:ServiceStack.Text.RecyclableMemoryStreamManager.LargePoolInUseSize">
  665. <summary>
  666. Number of bytes currently in use by streams from the large pool
  667. </summary>
  668. </member>
  669. <member name="P:ServiceStack.Text.RecyclableMemoryStreamManager.SmallBlocksFree">
  670. <summary>
  671. How many blocks are in the small pool
  672. </summary>
  673. </member>
  674. <member name="P:ServiceStack.Text.RecyclableMemoryStreamManager.LargeBuffersFree">
  675. <summary>
  676. How many buffers are in the large pool
  677. </summary>
  678. </member>
  679. <member name="P:ServiceStack.Text.RecyclableMemoryStreamManager.MaximumFreeSmallPoolBytes">
  680. <summary>
  681. How many bytes of small free blocks to allow before we start dropping
  682. those returned to us.
  683. </summary>
  684. </member>
  685. <member name="P:ServiceStack.Text.RecyclableMemoryStreamManager.MaximumFreeLargePoolBytes">
  686. <summary>
  687. How many bytes of large free buffers to allow before we start dropping
  688. those returned to us.
  689. </summary>
  690. </member>
  691. <member name="P:ServiceStack.Text.RecyclableMemoryStreamManager.MaximumStreamCapacity">
  692. <summary>
  693. Maximum stream capacity in bytes. Attempts to set a larger capacity will
  694. result in an exception.
  695. </summary>
  696. <remarks>A value of 0 indicates no limit.</remarks>
  697. </member>
  698. <member name="P:ServiceStack.Text.RecyclableMemoryStreamManager.GenerateCallStacks">
  699. <summary>
  700. Whether to save callstacks for stream allocations. This can help in debugging.
  701. It should NEVER be turned on generally in production.
  702. </summary>
  703. </member>
  704. <member name="P:ServiceStack.Text.RecyclableMemoryStreamManager.AggressiveBufferReturn">
  705. <summary>
  706. Whether dirty buffers can be immediately returned to the buffer pool. E.g. when GetBuffer() is called on
  707. a stream and creates a single large buffer, if this setting is enabled, the other blocks will be returned
  708. to the buffer pool immediately.
  709. Note when enabling this setting that the user is responsible for ensuring that any buffer previously
  710. retrieved from a stream which is subsequently modified is not used after modification (as it may no longer
  711. be valid).
  712. </summary>
  713. </member>
  714. <member name="M:ServiceStack.Text.RecyclableMemoryStreamManager.GetBlock">
  715. <summary>
  716. Removes and returns a single block from the pool.
  717. </summary>
  718. <returns>A byte[] array</returns>
  719. </member>
  720. <member name="M:ServiceStack.Text.RecyclableMemoryStreamManager.GetLargeBuffer(System.Int32,System.String)">
  721. <summary>
  722. Returns a buffer of arbitrary size from the large buffer pool. This buffer
  723. will be at least the requiredSize and always be a multiple of largeBufferMultiple.
  724. </summary>
  725. <param name="requiredSize">The minimum length of the buffer</param>
  726. <param name="tag">The tag of the stream returning this buffer, for logging if necessary.</param>
  727. <returns>A buffer of at least the required size.</returns>
  728. </member>
  729. <member name="M:ServiceStack.Text.RecyclableMemoryStreamManager.ReturnLargeBuffer(System.Byte[],System.String)">
  730. <summary>
  731. Returns the buffer to the large pool
  732. </summary>
  733. <param name="buffer">The buffer to return.</param>
  734. <param name="tag">The tag of the stream returning this buffer, for logging if necessary.</param>
  735. <exception cref="T:System.ArgumentNullException">buffer is null</exception>
  736. <exception cref="T:System.ArgumentException">buffer.Length is not a multiple of LargeBufferMultiple (it did not originate from this pool)</exception>
  737. </member>
  738. <member name="M:ServiceStack.Text.RecyclableMemoryStreamManager.ReturnBlocks(System.Collections.Generic.ICollection{System.Byte[]},System.String)">
  739. <summary>
  740. Returns the blocks to the pool
  741. </summary>
  742. <param name="blocks">Collection of blocks to return to the pool</param>
  743. <param name="tag">The tag of the stream returning these blocks, for logging if necessary.</param>
  744. <exception cref="T:System.ArgumentNullException">blocks is null</exception>
  745. <exception cref="T:System.ArgumentException">blocks contains buffers that are the wrong size (or null) for this memory manager</exception>
  746. </member>
  747. <member name="M:ServiceStack.Text.RecyclableMemoryStreamManager.GetStream">
  748. <summary>
  749. Retrieve a new MemoryStream object with no tag and a default initial capacity.
  750. </summary>
  751. <returns>A MemoryStream.</returns>
  752. </member>
  753. <member name="M:ServiceStack.Text.RecyclableMemoryStreamManager.GetStream(System.String)">
  754. <summary>
  755. Retrieve a new MemoryStream object with the given tag and a default initial capacity.
  756. </summary>
  757. <param name="tag">A tag which can be used to track the source of the stream.</param>
  758. <returns>A MemoryStream.</returns>
  759. </member>
  760. <member name="M:ServiceStack.Text.RecyclableMemoryStreamManager.GetStream(System.String,System.Int32)">
  761. <summary>
  762. Retrieve a new MemoryStream object with the given tag and at least the given capacity.
  763. </summary>
  764. <param name="tag">A tag which can be used to track the source of the stream.</param>
  765. <param name="requiredSize">The minimum desired capacity for the stream.</param>
  766. <returns>A MemoryStream.</returns>
  767. </member>
  768. <member name="M:ServiceStack.Text.RecyclableMemoryStreamManager.GetStream(System.String,System.Int32,System.Boolean)">
  769. <summary>
  770. Retrieve a new MemoryStream object with the given tag and at least the given capacity, possibly using
  771. a single continugous underlying buffer.
  772. </summary>
  773. <remarks>Retrieving a MemoryStream which provides a single contiguous buffer can be useful in situations
  774. where the initial size is known and it is desirable to avoid copying data between the smaller underlying
  775. buffers to a single large one. This is most helpful when you know that you will always call GetBuffer
  776. on the underlying stream.</remarks>
  777. <param name="tag">A tag which can be used to track the source of the stream.</param>
  778. <param name="requiredSize">The minimum desired capacity for the stream.</param>
  779. <param name="asContiguousBuffer">Whether to attempt to use a single contiguous buffer.</param>
  780. <returns>A MemoryStream.</returns>
  781. </member>
  782. <member name="M:ServiceStack.Text.RecyclableMemoryStreamManager.GetStream(System.String,System.Byte[],System.Int32,System.Int32)">
  783. <summary>
  784. Retrieve a new MemoryStream object with the given tag and with contents copied from the provided
  785. buffer. The provided buffer is not wrapped or used after construction.
  786. </summary>
  787. <remarks>The new stream's position is set to the beginning of the stream when returned.</remarks>
  788. <param name="tag">A tag which can be used to track the source of the stream.</param>
  789. <param name="buffer">The byte buffer to copy data from.</param>
  790. <param name="offset">The offset from the start of the buffer to copy from.</param>
  791. <param name="count">The number of bytes to copy from the buffer.</param>
  792. <returns>A MemoryStream.</returns>
  793. </member>
  794. <member name="E:ServiceStack.Text.RecyclableMemoryStreamManager.BlockCreated">
  795. <summary>
  796. Triggered when a new block is created.
  797. </summary>
  798. </member>
  799. <member name="E:ServiceStack.Text.RecyclableMemoryStreamManager.BlockDiscarded">
  800. <summary>
  801. Triggered when a new block is created.
  802. </summary>
  803. </member>
  804. <member name="E:ServiceStack.Text.RecyclableMemoryStreamManager.LargeBufferCreated">
  805. <summary>
  806. Triggered when a new large buffer is created.
  807. </summary>
  808. </member>
  809. <member name="E:ServiceStack.Text.RecyclableMemoryStreamManager.StreamCreated">
  810. <summary>
  811. Triggered when a new stream is created.
  812. </summary>
  813. </member>
  814. <member name="E:ServiceStack.Text.RecyclableMemoryStreamManager.StreamDisposed">
  815. <summary>
  816. Triggered when a stream is disposed.
  817. </summary>
  818. </member>
  819. <member name="E:ServiceStack.Text.RecyclableMemoryStreamManager.StreamFinalized">
  820. <summary>
  821. Triggered when a stream is finalized.
  822. </summary>
  823. </member>
  824. <member name="E:ServiceStack.Text.RecyclableMemoryStreamManager.StreamLength">
  825. <summary>
  826. Triggered when a stream is finalized.
  827. </summary>
  828. </member>
  829. <member name="E:ServiceStack.Text.RecyclableMemoryStreamManager.StreamConvertedToArray">
  830. <summary>
  831. Triggered when a user converts a stream to array.
  832. </summary>
  833. </member>
  834. <member name="E:ServiceStack.Text.RecyclableMemoryStreamManager.LargeBufferDiscarded">
  835. <summary>
  836. Triggered when a large buffer is discarded, along with the reason for the discard.
  837. </summary>
  838. </member>
  839. <member name="E:ServiceStack.Text.RecyclableMemoryStreamManager.UsageReport">
  840. <summary>
  841. Periodically triggered to report usage statistics.
  842. </summary>
  843. </member>
  844. <member name="T:ServiceStack.Text.RecyclableMemoryStream">
  845. <summary>
  846. MemoryStream implementation that deals with pooling and managing memory streams which use potentially large
  847. buffers.
  848. </summary>
  849. <remarks>
  850. This class works in tandem with the RecylableMemoryStreamManager to supply MemoryStream
  851. objects to callers, while avoiding these specific problems:
  852. 1. LOH allocations - since all large buffers are pooled, they will never incur a Gen2 GC
  853. 2. Memory waste - A standard memory stream doubles its size when it runs out of room. This
  854. leads to continual memory growth as each stream approaches the maximum allowed size.
  855. 3. Memory copying - Each time a MemoryStream grows, all the bytes are copied into new buffers.
  856. This implementation only copies the bytes when GetBuffer is called.
  857. 4. Memory fragmentation - By using homogeneous buffer sizes, it ensures that blocks of memory
  858. can be easily reused.
  859. The stream is implemented on top of a series of uniformly-sized blocks. As the stream's length grows,
  860. additional blocks are retrieved from the memory manager. It is these blocks that are pooled, not the stream
  861. object itself.
  862. The biggest wrinkle in this implementation is when GetBuffer() is called. This requires a single
  863. contiguous buffer. If only a single block is in use, then that block is returned. If multiple blocks
  864. are in use, we retrieve a larger buffer from the memory manager. These large buffers are also pooled,
  865. split by size--they are multiples of a chunk size (1 MB by default).
  866. Once a large buffer is assigned to the stream the blocks are NEVER again used for this stream. All operations take place on the
  867. large buffer. The large buffer can be replaced by a larger buffer from the pool as needed. All blocks and large buffers
  868. are maintained in the stream until the stream is disposed (unless AggressiveBufferReturn is enabled in the stream manager).
  869. </remarks>
  870. </member>
  871. <member name="F:ServiceStack.Text.RecyclableMemoryStream.blocks">
  872. <summary>
  873. All of these blocks must be the same size
  874. </summary>
  875. </member>
  876. <member name="F:ServiceStack.Text.RecyclableMemoryStream.largeBuffer">
  877. <summary>
  878. This is only set by GetBuffer() if the necessary buffer is larger than a single block size, or on
  879. construction if the caller immediately requests a single large buffer.
  880. </summary>
  881. <remarks>If this field is non-null, it contains the concatenation of the bytes found in the individual
  882. blocks. Once it is created, this (or a larger) largeBuffer will be used for the life of the stream.
  883. </remarks>
  884. </member>
  885. <member name="F:ServiceStack.Text.RecyclableMemoryStream.dirtyBuffers">
  886. <summary>
  887. This list is used to store buffers once they're replaced by something larger.
  888. This is for the cases where you have users of this class that may hold onto the buffers longer
  889. than they should and you want to prevent race conditions which could corrupt the data.
  890. </summary>
  891. </member>
  892. <member name="P:ServiceStack.Text.RecyclableMemoryStream.Id">
  893. <summary>
  894. Unique identifier for this stream across it's entire lifetime
  895. </summary>
  896. <exception cref="T:System.ObjectDisposedException">Object has been disposed</exception>
  897. </member>
  898. <member name="P:ServiceStack.Text.RecyclableMemoryStream.Tag">
  899. <summary>
  900. A temporary identifier for the current usage of this stream.
  901. </summary>
  902. <exception cref="T:System.ObjectDisposedException">Object has been disposed</exception>
  903. </member>
  904. <member name="P:ServiceStack.Text.RecyclableMemoryStream.MemoryManager">
  905. <summary>
  906. Gets the memory manager being used by this stream.
  907. </summary>
  908. <exception cref="T:System.ObjectDisposedException">Object has been disposed</exception>
  909. </member>
  910. <member name="P:ServiceStack.Text.RecyclableMemoryStream.AllocationStack">
  911. <summary>
  912. Callstack of the constructor. It is only set if MemoryManager.GenerateCallStacks is true,
  913. which should only be in debugging situations.
  914. </summary>
  915. </member>
  916. <member name="P:ServiceStack.Text.RecyclableMemoryStream.DisposeStack">
  917. <summary>
  918. Callstack of the Dispose call. It is only set if MemoryManager.GenerateCallStacks is true,
  919. which should only be in debugging situations.
  920. </summary>
  921. </member>
  922. <member name="F:ServiceStack.Text.RecyclableMemoryStream.byteBuffer">
  923. <summary>
  924. This buffer exists so that WriteByte can forward all of its calls to Write
  925. without creating a new byte[] buffer on every call.
  926. </summary>
  927. </member>
  928. <member name="M:ServiceStack.Text.RecyclableMemoryStream.#ctor(ServiceStack.Text.RecyclableMemoryStreamManager)">
  929. <summary>
  930. Allocate a new RecyclableMemoryStream object.
  931. </summary>
  932. <param name="memoryManager">The memory manager</param>
  933. </member>
  934. <member name="M:ServiceStack.Text.RecyclableMemoryStream.#ctor(ServiceStack.Text.RecyclableMemoryStreamManager,System.String)">
  935. <summary>
  936. Allocate a new RecyclableMemoryStream object
  937. </summary>
  938. <param name="memoryManager">The memory manager</param>
  939. <param name="tag">A string identifying this stream for logging and debugging purposes</param>
  940. </member>
  941. <member name="M:ServiceStack.Text.RecyclableMemoryStream.#ctor(ServiceStack.Text.RecyclableMemoryStreamManager,System.String,System.Int32)">
  942. <summary>
  943. Allocate a new RecyclableMemoryStream object
  944. </summary>
  945. <param name="memoryManager">The memory manager</param>
  946. <param name="tag">A string identifying this stream for logging and debugging purposes</param>
  947. <param name="requestedSize">The initial requested size to prevent future allocations</param>
  948. </member>
  949. <member name="M:ServiceStack.Text.RecyclableMemoryStream.#ctor(ServiceStack.Text.RecyclableMemoryStreamManager,System.String,System.Int32,System.Byte[])">
  950. <summary>
  951. Allocate a new RecyclableMemoryStream object
  952. </summary>
  953. <param name="memoryManager">The memory manager</param>
  954. <param name="tag">A string identifying this stream for logging and debugging purposes</param>
  955. <param name="requestedSize">The initial requested size to prevent future allocations</param>
  956. <param name="initialLargeBuffer">An initial buffer to use. This buffer will be owned by the stream and returned to the memory manager upon Dispose.</param>
  957. </member>
  958. <member name="M:ServiceStack.Text.RecyclableMemoryStream.Dispose(System.Boolean)">
  959. <summary>
  960. Returns the memory used by this stream back to the pool.
  961. </summary>
  962. <param name="disposing">Whether we're disposing (true), or being called by the finalizer (false)</param>
  963. <remarks>This method is not thread safe and it may not be called more than once.</remarks>
  964. </member>
  965. <member name="M:ServiceStack.Text.RecyclableMemoryStream.Close">
  966. <summary>
  967. Equivalent to Dispose
  968. </summary>
  969. </member>
  970. <member name="P:ServiceStack.Text.RecyclableMemoryStream.Capacity">
  971. <summary>
  972. Gets or sets the capacity
  973. </summary>
  974. <remarks>Capacity is always in multiples of the memory manager's block size, unless
  975. the large buffer is in use. Capacity never decreases during a stream's lifetime.
  976. Explicitly setting the capacity to a lower value than the current value will have no effect.
  977. This is because the buffers are all pooled by chunks and there's little reason to
  978. allow stream truncation.
  979. </remarks>
  980. <exception cref="T:System.ObjectDisposedException">Object has been disposed</exception>
  981. </member>
  982. <member name="P:ServiceStack.Text.RecyclableMemoryStream.Length">
  983. <summary>
  984. Gets the number of bytes written to this stream.
  985. </summary>
  986. <exception cref="T:System.ObjectDisposedException">Object has been disposed</exception>
  987. </member>
  988. <member name="P:ServiceStack.Text.RecyclableMemoryStream.Position">
  989. <summary>
  990. Gets the current position in the stream
  991. </summary>
  992. <exception cref="T:System.ObjectDisposedException">Object has been disposed</exception>
  993. </member>
  994. <member name="P:ServiceStack.Text.RecyclableMemoryStream.CanRead">
  995. <summary>
  996. Whether the stream can currently read
  997. </summary>
  998. </member>
  999. <member name="P:ServiceStack.Text.RecyclableMemoryStream.CanSeek">
  1000. <summary>
  1001. Whether the stream can currently seek
  1002. </summary>
  1003. </member>
  1004. <member name="P:ServiceStack.Text.RecyclableMemoryStream.CanTimeout">
  1005. <summary>
  1006. Always false
  1007. </summary>
  1008. </member>
  1009. <member name="P:ServiceStack.Text.RecyclableMemoryStream.CanWrite">
  1010. <summary>
  1011. Whether the stream can currently write
  1012. </summary>
  1013. </member>
  1014. <member name="M:ServiceStack.Text.RecyclableMemoryStream.GetBuffer">
  1015. <summary>
  1016. Returns a single buffer containing the contents of the stream.
  1017. The buffer may be longer than the stream length.
  1018. </summary>
  1019. <returns>A byte[] buffer</returns>
  1020. <remarks>IMPORTANT: Doing a Write() after calling GetBuffer() invalidates the buffer. The old buffer is held onto
  1021. until Dispose is called, but the next time GetBuffer() is called, a new buffer from the pool will be required.</remarks>
  1022. <exception cref="T:System.ObjectDisposedException">Object has been disposed</exception>
  1023. </member>
  1024. <member name="M:ServiceStack.Text.RecyclableMemoryStream.ToArray">
  1025. <summary>
  1026. Returns a new array with a copy of the buffer's contents. You should almost certainly be using GetBuffer combined with the Length to
  1027. access the bytes in this stream. Calling ToArray will destroy the benefits of pooled buffers, but it is included
  1028. for the sake of completeness.
  1029. </summary>
  1030. <exception cref="T:System.ObjectDisposedException">Object has been disposed</exception>
  1031. </member>
  1032. <member name="M:ServiceStack.Text.RecyclableMemoryStream.Read(System.Byte[],System.Int32,System.Int32)">
  1033. <summary>
  1034. Reads from the current position into the provided buffer
  1035. </summary>
  1036. <param name="buffer">Destination buffer</param>
  1037. <param name="offset">Offset into buffer at which to start placing the read bytes.</param>
  1038. <param name="count">Number of bytes to read.</param>
  1039. <returns>The number of bytes read</returns>
  1040. <exception cref="T:System.ArgumentNullException">buffer is null</exception>
  1041. <exception cref="T:System.ArgumentOutOfRangeException">offset or count is less than 0</exception>
  1042. <exception cref="T:System.ArgumentException">offset subtracted from the buffer length is less than count</exception>
  1043. <exception cref="T:System.ObjectDisposedException">Object has been disposed</exception>
  1044. </member>
  1045. <member name="M:ServiceStack.Text.RecyclableMemoryStream.Write(System.Byte[],System.Int32,System.Int32)">
  1046. <summary>
  1047. Writes the buffer to the stream
  1048. </summary>
  1049. <param name="buffer">Source buffer</param>
  1050. <param name="offset">Start position</param>
  1051. <param name="count">Number of bytes to write</param>
  1052. <exception cref="T:System.ArgumentNullException">buffer is null</exception>
  1053. <exception cref="T:System.ArgumentOutOfRangeException">offset or count is negative</exception>
  1054. <exception cref="T:System.ArgumentException">buffer.Length - offset is not less than count</exception>
  1055. <exception cref="T:System.ObjectDisposedException">Object has been disposed</exception>
  1056. </member>
  1057. <member name="M:ServiceStack.Text.RecyclableMemoryStream.ToString">
  1058. <summary>
  1059. Returns a useful string for debugging. This should not normally be called in actual production code.
  1060. </summary>
  1061. </member>
  1062. <member name="M:ServiceStack.Text.RecyclableMemoryStream.WriteByte(System.Byte)">
  1063. <summary>
  1064. Writes a single byte to the current position in the stream.
  1065. </summary>
  1066. <param name="value">byte value to write</param>
  1067. <exception cref="T:System.ObjectDisposedException">Object has been disposed</exception>
  1068. </member>
  1069. <member name="M:ServiceStack.Text.RecyclableMemoryStream.ReadByte">
  1070. <summary>
  1071. Reads a single byte from the current position in the stream.
  1072. </summary>
  1073. <returns>The byte at the current position, or -1 if the position is at the end of the stream.</returns>
  1074. <exception cref="T:System.ObjectDisposedException">Object has been disposed</exception>
  1075. </member>
  1076. <member name="M:ServiceStack.Text.RecyclableMemoryStream.SetLength(System.Int64)">
  1077. <summary>
  1078. Sets the length of the stream
  1079. </summary>
  1080. <exception cref="T:System.ArgumentOutOfRangeException">value is negative or larger than MaxStreamLength</exception>
  1081. <exception cref="T:System.ObjectDisposedException">Object has been disposed</exception>
  1082. </member>
  1083. <member name="M:ServiceStack.Text.RecyclableMemoryStream.Seek(System.Int64,System.IO.SeekOrigin)">
  1084. <summary>
  1085. Sets the position to the offset from the seek location
  1086. </summary>
  1087. <param name="offset">How many bytes to move</param>
  1088. <param name="loc">From where</param>
  1089. <returns>The new position</returns>
  1090. <exception cref="T:System.ObjectDisposedException">Object has been disposed</exception>
  1091. <exception cref="T:System.ArgumentOutOfRangeException">offset is larger than MaxStreamLength</exception>
  1092. <exception cref="T:System.ArgumentException">Invalid seek origin</exception>
  1093. <exception cref="T:System.IO.IOException">Attempt to set negative position</exception>
  1094. </member>
  1095. <member name="M:ServiceStack.Text.RecyclableMemoryStream.WriteTo(System.IO.Stream)">
  1096. <summary>
  1097. Synchronously writes this stream's bytes to the parameter stream.
  1098. </summary>
  1099. <param name="stream">Destination stream</param>
  1100. <remarks>Important: This does a synchronous write, which may not be desired in some situations</remarks>
  1101. </member>
  1102. <member name="M:ServiceStack.Text.RecyclableMemoryStream.ReleaseLargeBuffer">
  1103. <summary>
  1104. Release the large buffer (either stores it for eventual release or returns it immediately).
  1105. </summary>
  1106. </member>
  1107. <member name="T:ServiceStack.Text.Support.DoubleConverter">
  1108. <summary>
  1109. A class to allow the conversion of doubles to string representations of
  1110. their exact decimal values. The implementation aims for readability over
  1111. efficiency.
  1112. Courtesy of @JonSkeet
  1113. http://www.yoda.arachsys.com/csharp/DoubleConverter.cs
  1114. </summary>
  1115. </member>
  1116. <!-- Badly formed XML comment ignored for member "M:ServiceStack.Text.Support.DoubleConverter.ToExactString(System.Double)" -->
  1117. <!-- Badly formed XML comment ignored for member "T:ServiceStack.Text.Support.DoubleConverter.ArbitraryDecimal" -->
  1118. <!-- Badly formed XML comment ignored for member "F:ServiceStack.Text.Support.DoubleConverter.ArbitraryDecimal.digits" -->
  1119. <member name="F:ServiceStack.Text.Support.DoubleConverter.ArbitraryDecimal.decimalPoint">
  1120. <summary>
  1121. How many digits are *after* the decimal point
  1122. </summary>
  1123. </member>
  1124. <member name="M:ServiceStack.Text.Support.DoubleConverter.ArbitraryDecimal.#ctor(System.Int64)">
  1125. <summary>
  1126. Constructs an arbitrary decimal expansion from the given long.
  1127. The long must not be negative.
  1128. </summary>
  1129. </member>
  1130. <member name="M:ServiceStack.Text.Support.DoubleConverter.ArbitraryDecimal.MultiplyBy(System.Int32)">
  1131. <summary>
  1132. Multiplies the current expansion by the given amount, which should
  1133. only be 2 or 5.
  1134. </summary>
  1135. </member>
  1136. <member name="M:ServiceStack.Text.Support.DoubleConverter.ArbitraryDecimal.Shift(System.Int32)">
  1137. <summary>
  1138. Shifts the decimal point; a negative value makes
  1139. the decimal expansion bigger (as fewer digits come after the
  1140. decimal place) and a positive value makes the decimal
  1141. expansion smaller.
  1142. </summary>
  1143. </member>
  1144. <member name="M:ServiceStack.Text.Support.DoubleConverter.ArbitraryDecimal.Normalize">
  1145. <summary>
  1146. Removes leading/trailing zeroes from the expansion.
  1147. </summary>
  1148. </member>
  1149. <member name="M:ServiceStack.Text.Support.DoubleConverter.ArbitraryDecimal.ToString">
  1150. <summary>
  1151. Converts the value to a proper decimal string representation.
  1152. </summary>
  1153. </member>
  1154. <member name="T:ServiceStack.Text.TypeSerializer">
  1155. <summary>
  1156. Creates an instance of a Type from a string value
  1157. </summary>
  1158. </member>
  1159. <member name="M:ServiceStack.Text.TypeSerializer.CanCreateFromString(System.Type)">
  1160. <summary>
  1161. Determines whether the specified type is convertible from string.
  1162. </summary>
  1163. <param name="type">The type.</param>
  1164. <returns>
  1165. <c>true</c> if the specified type is convertible from string; otherwise, <c>false</c>.
  1166. </returns>
  1167. </member>
  1168. <member name="M:ServiceStack.Text.TypeSerializer.DeserializeFromString``1(System.String)">
  1169. <summary>
  1170. Parses the specified value.
  1171. </summary>
  1172. <param name="value">The value.</param>
  1173. <returns></returns>
  1174. </member>
  1175. <member name="M:ServiceStack.Text.TypeSerializer.DeserializeFromString(System.String,System.Type)">
  1176. <summary>
  1177. Parses the specified type.
  1178. </summary>
  1179. <param name="type">The type.</param>
  1180. <param name="value">The value.</param>
  1181. <returns></returns>
  1182. </member>
  1183. <member name="M:ServiceStack.Text.TypeSerializer.ToStringDictionary``1(``0)">
  1184. <summary>
  1185. Useful extension method to get the Dictionary[string,string] representation of any POCO type.
  1186. </summary>
  1187. <returns></returns>
  1188. </member>
  1189. <member name="M:ServiceStack.Text.TypeSerializer.Dump``1(``0)">
  1190. <summary>
  1191. Recursively prints the contents of any POCO object in a human-friendly, readable format
  1192. </summary>
  1193. <returns></returns>
  1194. </member>
  1195. <member name="M:ServiceStack.Text.TypeSerializer.PrintDump``1(``0)">
  1196. <summary>
  1197. Print Dump to Console.WriteLine
  1198. </summary>
  1199. </member>
  1200. <member name="M:ServiceStack.Text.TypeSerializer.Print(System.String,System.Object[])">
  1201. <summary>
  1202. Print string.Format to Console.WriteLine
  1203. </summary>
  1204. </member>
  1205. <member name="M:ServiceStack.Text.TypeSerializer`1.DeserializeFromString(System.String)">
  1206. <summary>
  1207. Parses the specified value.
  1208. </summary>
  1209. <param name="value">The value.</param>
  1210. <returns></returns>
  1211. </member>
  1212. <member name="M:ServiceStack.AutoMappingUtils.PopulateWith(System.Object)">
  1213. <summary>
  1214. Populate an object with Example data.
  1215. </summary>
  1216. <param name="obj"></param>
  1217. <returns></returns>
  1218. </member>
  1219. <member name="M:ServiceStack.AutoMappingUtils.PopulateObjectInternal(System.Object,System.Collections.Generic.Dictionary{System.Type,System.Int32})">
  1220. <summary>
  1221. Populates the object with example data.
  1222. </summary>
  1223. <param name="obj"></param>
  1224. <param name="recursionInfo">Tracks how deeply nested we are</param>
  1225. <returns></returns>
  1226. </member>
  1227. <member name="T:ServiceStack.Licensing">
  1228. <summary>
  1229. Public Code API to register commercial license for ServiceStack.
  1230. </summary>
  1231. </member>
  1232. <member name="T:ServiceStack.LicenseUtils">
  1233. <summary>
  1234. Internal Utilities to verify licensing
  1235. </summary>
  1236. </member>
  1237. <member name="M:ServiceStack.PathUtils.MapProjectPath(System.String)">
  1238. <summary>
  1239. Maps the path of a file in the context of a VS project
  1240. </summary>
  1241. <param name="relativePath">the relative path</param>
  1242. <returns>the absolute path</returns>
  1243. <remarks>Assumes static content is two directories above the /bin/ directory,
  1244. eg. in a unit test scenario the assembly would be in /bin/Debug/.</remarks>
  1245. </member>
  1246. <member name="M:ServiceStack.PathUtils.MapAbsolutePath(System.String)">
  1247. <summary>
  1248. Maps the path of a file in a self-hosted scenario
  1249. </summary>
  1250. <param name="relativePath">the relative path</param>
  1251. <returns>the absolute path</returns>
  1252. <remarks>Assumes static content is copied to /bin/ folder with the assemblies</remarks>
  1253. </member>
  1254. <member name="M:ServiceStack.PathUtils.MapHostAbsolutePath(System.String)">
  1255. <summary>
  1256. Maps the path of a file in an Asp.Net hosted scenario
  1257. </summary>
  1258. <param name="relativePath">the relative path</param>
  1259. <returns>the absolute path</returns>
  1260. <remarks>Assumes static content is in the parent folder of the /bin/ directory</remarks>
  1261. </member>
  1262. <member name="T:ServiceStack.QueryStringWriter`1">
  1263. <summary>
  1264. Implement the serializer using a more static approach
  1265. </summary>
  1266. <typeparam name="T"></typeparam>
  1267. </member>
  1268. <member name="M:ServiceStack.ReflectionExtensions.New``1(System.Type)">
  1269. <summary>
  1270. Creates a new instance of type.
  1271. First looks at JsConfig.ModelFactory before falling back to CreateInstance
  1272. </summary>
  1273. </member>
  1274. <member name="M:ServiceStack.ReflectionExtensions.New(System.Type)">
  1275. <summary>
  1276. Creates a new instance of type.
  1277. First looks at JsConfig.ModelFactory before falling back to CreateInstance
  1278. </summary>
  1279. </member>
  1280. <member name="M:ServiceStack.ReflectionExtensions.CreateInstance(System.Type)">
  1281. <summary>
  1282. Creates a new instance from the default constructor of type
  1283. </summary>
  1284. </member>
  1285. <member name="M:ServiceStack.PlatformExtensions.AddAttributes(System.Reflection.PropertyInfo,System.Attribute[])">
  1286. <summary>
  1287. Add a Property attribute at runtime.
  1288. <para>Not threadsafe, should only add attributes on Startup.</para>
  1289. </summary>
  1290. </member>
  1291. <member name="M:ServiceStack.PlatformExtensions.ReplaceAttribute(System.Reflection.PropertyInfo,System.Attribute)">
  1292. <summary>
  1293. Add a Property attribute at runtime.
  1294. <para>Not threadsafe, should only add attributes on Startup.</para>
  1295. </summary>
  1296. </member>
  1297. <member name="F:ServiceStack.StreamExtensions.DefaultBufferSize">
  1298. <summary>
  1299. @jonskeet: Collection of utility methods which operate on streams.
  1300. r285, February 26th 2009: http://www.yoda.arachsys.com/csharp/miscutil/
  1301. </summary>
  1302. </member>
  1303. <member name="M:ServiceStack.StreamExtensions.ReadFully(System.IO.Stream)">
  1304. <summary>
  1305. Reads the given stream up to the end, returning the data as a byte
  1306. array.
  1307. </summary>
  1308. </member>
  1309. <member name="M:ServiceStack.StreamExtensions.ReadFully(System.IO.Stream,System.Int32)">
  1310. <summary>
  1311. Reads the given stream up to the end, returning the data as a byte
  1312. array, using the given buffer size.
  1313. </summary>
  1314. </member>
  1315. <member name="M:ServiceStack.StreamExtensions.ReadFully(System.IO.Stream,System.Byte[])">
  1316. <summary>
  1317. Reads the given stream up to the end, returning the data as a byte
  1318. array, using the given buffer for transferring data. Note that the
  1319. current contents of the buffer is ignored, so the buffer needn't
  1320. be cleared beforehand.
  1321. </summary>
  1322. </member>
  1323. <member name="M:ServiceStack.StreamExtensions.CopyTo(System.IO.Stream,System.IO.Stream)">
  1324. <summary>
  1325. Copies all the data from one stream into another.
  1326. </summary>
  1327. </member>
  1328. <member name="M:ServiceStack.StreamExtensions.CopyTo(System.IO.Stream,System.IO.Stream,System.Int32)">
  1329. <summary>
  1330. Copies all the data from one stream into another, using a buffer
  1331. of the given size.
  1332. </summary>
  1333. </member>
  1334. <member name="M:ServiceStack.StreamExtensions.CopyTo(System.IO.Stream,System.IO.Stream,System.Byte[])">
  1335. <summary>
  1336. Copies all the data from one stream into another, using the given
  1337. buffer for transferring data. Note that the current contents of
  1338. the buffer is ignored, so the buffer needn't be cleared beforehand.
  1339. </summary>
  1340. </member>
  1341. <member name="M:ServiceStack.StreamExtensions.ReadExactly(System.IO.Stream,System.Int32)">
  1342. <summary>
  1343. Reads exactly the given number of bytes from the specified stream.
  1344. If the end of the stream is reached before the specified amount
  1345. of data is read, an exception is thrown.
  1346. </summary>
  1347. </member>
  1348. <member name="M:ServiceStack.StreamExtensions.ReadExactly(System.IO.Stream,System.Byte[])">
  1349. <summary>
  1350. Reads into a buffer, filling it completely.
  1351. </summary>
  1352. </member>
  1353. <member name="M:ServiceStack.StreamExtensions.ReadExactly(System.IO.Stream,System.Byte[],System.Int32)">
  1354. <summary>
  1355. Reads exactly the given number of bytes from the specified stream,
  1356. into the given buffer, starting at position 0 of the array.
  1357. </summary>
  1358. </member>
  1359. <member name="M:ServiceStack.StreamExtensions.ReadExactly(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
  1360. <summary>
  1361. Reads exactly the given number of bytes from the specified stream,
  1362. into the given buffer, starting at position 0 of the array.
  1363. </summary>
  1364. </member>
  1365. <member name="M:ServiceStack.StreamExtensions.ReadExactlyFast(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
  1366. <summary>
  1367. Same as ReadExactly, but without the argument checks.
  1368. </summary>
  1369. </member>
  1370. <member name="M:ServiceStack.StringExtensions.BaseConvert(System.String,System.Int32,System.Int32)">
  1371. <summary>
  1372. Converts from base: 0 - 62
  1373. </summary>
  1374. <param name="source">The source.</param>
  1375. <param name="from">From.</param>
  1376. <param name="to">To.</param>
  1377. <returns></returns>
  1378. </member>
  1379. <member name="M:ServiceStack.StringExtensions.FastToUtf8Bytes(System.String)">
  1380. <summary>
  1381. Skip the encoding process for 'safe strings'
  1382. </summary>
  1383. <param name="strVal"></param>
  1384. <returns></returns>
  1385. </member>
  1386. </members>
  1387. </doc>