1 <?xml version="1.0"?>
\r
4 <name>Microsoft.AspNetCore.Components.Server</name>
\r
7 <member name="T:Microsoft.Extensions.DependencyInjection.ComponentServiceCollectionExtensions">
\r
9 Extension methods to configure an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for components.
\r
12 <member name="M:Microsoft.Extensions.DependencyInjection.ComponentServiceCollectionExtensions.AddServerSideBlazor(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.AspNetCore.Components.Server.CircuitOptions})">
\r
14 Adds Server-Side Blazor services to the service collection.
\r
16 <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
\r
17 <param name="configure">A callback to configure <see cref="T:Microsoft.AspNetCore.Components.Server.CircuitOptions"/>.</param>
\r
18 <returns>An <see cref="T:Microsoft.Extensions.DependencyInjection.IServerSideBlazorBuilder"/> that can be used to further customize the configuration.</returns>
\r
20 <member name="T:Microsoft.Extensions.DependencyInjection.IServerSideBlazorBuilder">
\r
22 A builder that can be used to configure Server-Side Blazor.
\r
25 <member name="P:Microsoft.Extensions.DependencyInjection.IServerSideBlazorBuilder.Services">
\r
27 Gets the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.
\r
30 <member name="T:Microsoft.Extensions.DependencyInjection.ServerSideBlazorBuilderExtensions">
\r
32 Provides options for configuring Server-Side Blazor.
\r
35 <member name="M:Microsoft.Extensions.DependencyInjection.ServerSideBlazorBuilderExtensions.AddCircuitOptions(Microsoft.Extensions.DependencyInjection.IServerSideBlazorBuilder,System.Action{Microsoft.AspNetCore.Components.Server.CircuitOptions})">
\r
37 Adds options to configure circuits.
\r
39 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServerSideBlazorBuilder"/>.</param>
\r
40 <param name="configure">A callback to configure <see cref="T:Microsoft.AspNetCore.Components.Server.CircuitOptions"/>.</param>
\r
41 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServerSideBlazorBuilder"/>.</returns>
\r
43 <member name="M:Microsoft.Extensions.DependencyInjection.ServerSideBlazorBuilderExtensions.AddHubOptions(Microsoft.Extensions.DependencyInjection.IServerSideBlazorBuilder,System.Action{Microsoft.AspNetCore.SignalR.HubOptions})">
\r
45 Adds hub options for the configuration of the SignalR Hub used by Server-Side Blazor.
\r
47 <param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServerSideBlazorBuilder"/>.</param>
\r
48 <param name="configure">A callback to configure the hub options.</param>
\r
49 <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServerSideBlazorBuilder"/>.</returns>
\r
51 <member name="T:Microsoft.AspNetCore.Components.Server.BlazorPack.BlazorPackHubProtocol">
\r
53 Implements the SignalR Hub Protocol using MessagePack with limited type support.
\r
56 <member name="P:Microsoft.AspNetCore.Components.Server.BlazorPack.BlazorPackHubProtocol.Name">
\r
59 <member name="P:Microsoft.AspNetCore.Components.Server.BlazorPack.BlazorPackHubProtocol.Version">
\r
62 <member name="P:Microsoft.AspNetCore.Components.Server.BlazorPack.BlazorPackHubProtocol.TransferFormat">
\r
65 <member name="M:Microsoft.AspNetCore.Components.Server.BlazorPack.BlazorPackHubProtocol.IsVersionSupported(System.Int32)">
\r
68 <member name="M:Microsoft.AspNetCore.Components.Server.BlazorPack.BlazorPackHubProtocol.TryParseMessage(System.Buffers.ReadOnlySequence{System.Byte}@,Microsoft.AspNetCore.SignalR.IInvocationBinder,Microsoft.AspNetCore.SignalR.Protocol.HubMessage@)">
\r
71 <member name="M:Microsoft.AspNetCore.Components.Server.BlazorPack.BlazorPackHubProtocol.WriteMessage(Microsoft.AspNetCore.SignalR.Protocol.HubMessage,System.Buffers.IBufferWriter{System.Byte})">
\r
74 <member name="T:Microsoft.AspNetCore.Components.Server.CircuitOptions">
\r
76 Options to configure circuit handler for server-side Blazor
\r
79 <member name="P:Microsoft.AspNetCore.Components.Server.CircuitOptions.DisconnectedCircuitMaxRetained">
\r
81 Gets or sets a value that determines the maximum number of disconnected circuit state details
\r
82 are retained by the server.
\r
84 When a client disconnects, ASP.NET Core Components attempts to retain state on the server for an
\r
85 interval. This allows the client to re-establish a connection to the existing circuit on the server
\r
86 without losing any state in the event of transient connection issues.
\r
89 This value determines the maximium number of circuit states retained by the server.
\r
90 <seealso cref="P:Microsoft.AspNetCore.Components.Server.CircuitOptions.DisconnectedCircuitRetentionPeriod"/>
\r
94 Defaults to <c>100</c>.
\r
97 <member name="P:Microsoft.AspNetCore.Components.Server.CircuitOptions.DisconnectedCircuitRetentionPeriod">
\r
99 Gets or sets a value that determines the maximum duration state for a disconnected circuit is
\r
100 retained on the server.
\r
102 When a client disconnects, ASP.NET Core Components attempts to retain state on the server for an
\r
103 interval. This allows the client to re-establish a connection to the existing circuit on the server
\r
104 without losing any state in the event of transient connection issues.
\r
107 This value determines the maximium duration circuit state is retained by the server before being evicted.
\r
108 <seealso cref="P:Microsoft.AspNetCore.Components.Server.CircuitOptions.DisconnectedCircuitMaxRetained"/>
\r
112 Defaults to <c>3 minutes</c>.
\r
115 <member name="P:Microsoft.AspNetCore.Components.Server.CircuitOptions.DetailedErrors">
\r
117 Gets or sets a value that determines whether or not to send detailed exception messages to JavaScript when an unhandled exception
\r
118 happens on the circuit or when a .NET method invocation through JS interop results in an exception.
\r
121 This value should only be turned on in development scenarios as turning it on in production might result in the leak of
\r
122 sensitive information to untrusted parties.
\r
124 <value>Defaults to <c>false</c>.</value>
\r
126 <member name="P:Microsoft.AspNetCore.Components.Server.CircuitOptions.JSInteropDefaultCallTimeout">
\r
128 Gets or sets a value that indicates how long the server will wait before timing out an asynchronous JavaScript function invocation.
\r
131 Defaults to <c>1 minute</c>.
\r
134 <member name="P:Microsoft.AspNetCore.Components.Server.CircuitOptions.MaxBufferedUnacknowledgedRenderBatches">
\r
136 Gets or sets the maximum number of render batches that a circuit will buffer until an acknowledgement for the batch is
\r
140 When the limit of buffered render batches is reached components will stop rendering and will wait until either the
\r
141 circuit is disconnected and disposed or at least one batch gets acknowledged.
\r
144 Defaults to <c>10</c>.</value>
\r
146 <member name="T:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream">
\r
148 Writeable memory stream backed by a an <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilder`1"/>.
\r
151 <member name="P:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.CanRead">
\r
154 <member name="P:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.CanSeek">
\r
157 <member name="P:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.CanWrite">
\r
160 <member name="P:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.Length">
\r
163 <member name="P:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.Position">
\r
166 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.Seek(System.Int64,System.IO.SeekOrigin)">
\r
169 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.Read(System.Byte[],System.Int32,System.Int32)">
\r
172 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
\r
175 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.Write(System.Byte[],System.Int32,System.Int32)">
\r
178 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
\r
181 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.Flush">
\r
184 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.FlushAsync(System.Threading.CancellationToken)">
\r
187 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.SetLength(System.Int64)">
\r
190 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.Dispose(System.Boolean)">
\r
193 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilderMemoryStream.DisposeAsync">
\r
196 <member name="T:Microsoft.AspNetCore.Components.Server.Circuits.Circuit">
\r
198 Represents a link between a ASP.NET Core Component on the server and a client.
\r
201 <member name="P:Microsoft.AspNetCore.Components.Server.Circuits.Circuit.Id">
\r
203 Gets the identifier for the <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.Circuit"/>.
\r
206 <member name="T:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler">
\r
208 A <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler"/> allows running code during specific lifetime events of a <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.Circuit"/>.
\r
209 <list type="bullet">
\r
211 <see cref="M:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler.OnCircuitOpenedAsync(Microsoft.AspNetCore.Components.Server.Circuits.Circuit,System.Threading.CancellationToken)"/> is invoked after an initial circuit to the client
\r
212 has been established.
\r
215 <see cref="M:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler.OnConnectionUpAsync(Microsoft.AspNetCore.Components.Server.Circuits.Circuit,System.Threading.CancellationToken)"/> is invoked immediately after the completion of
\r
216 <see cref="M:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler.OnCircuitOpenedAsync(Microsoft.AspNetCore.Components.Server.Circuits.Circuit,System.Threading.CancellationToken)"/>. In addition, the method is invoked each time a connection is re-established
\r
217 with a client after it's been dropped. <see cref="M:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler.OnConnectionDownAsync(Microsoft.AspNetCore.Components.Server.Circuits.Circuit,System.Threading.CancellationToken)"/> is invoked each time a connection
\r
221 <see cref="M:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler.OnCircuitClosedAsync(Microsoft.AspNetCore.Components.Server.Circuits.Circuit,System.Threading.CancellationToken)"/> is invoked prior to the server evicting the circuit to the client.
\r
222 Application users may use this event to save state for a client that can be later rehydrated.
\r
227 <member name="P:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler.Order">
\r
229 Gets the execution order for the current instance of <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler"/>.
\r
231 When multiple <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler"/> instances are registered, the <see cref="P:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler.Order"/>
\r
232 property is used to determine the order in which instances are executed. When two handlers
\r
233 have the same value for <see cref="P:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler.Order"/>, their execution order is non-deterministic.
\r
240 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler.OnCircuitOpenedAsync(Microsoft.AspNetCore.Components.Server.Circuits.Circuit,System.Threading.CancellationToken)">
\r
242 Invoked when a new circuit was established.
\r
244 <param name="circuit">The <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.Circuit"/>.</param>
\r
245 <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that notifies when the client connection is aborted.</param>
\r
246 <returns><see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous execution operation.</returns>
\r
248 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler.OnConnectionUpAsync(Microsoft.AspNetCore.Components.Server.Circuits.Circuit,System.Threading.CancellationToken)">
\r
250 Invoked when a connection to the client was established.
\r
252 This method is executed once initially after <see cref="M:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler.OnCircuitOpenedAsync(Microsoft.AspNetCore.Components.Server.Circuits.Circuit,System.Threading.CancellationToken)"/>
\r
253 and once each for each reconnect during the lifetime of a circuit.
\r
256 <param name="circuit">The <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.Circuit"/>.</param>
\r
257 <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that notifies when the client connection is aborted.</param>
\r
258 <returns><see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous execution operation.</returns>
\r
260 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler.OnConnectionDownAsync(Microsoft.AspNetCore.Components.Server.Circuits.Circuit,System.Threading.CancellationToken)">
\r
262 Invoked when a connection to the client was dropped.
\r
264 <param name="circuit">The <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.Circuit"/>.</param>
\r
265 <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
\r
266 <returns><see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous execution operation.</returns>
\r
268 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHandler.OnCircuitClosedAsync(Microsoft.AspNetCore.Components.Server.Circuits.Circuit,System.Threading.CancellationToken)">
\r
270 Invoked when a new circuit is being discarded.
\r
272 <param name="circuit">The <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.Circuit"/>.</param>
\r
273 <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
\r
274 <returns><see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous execution operation.</returns>
\r
276 <member name="T:Microsoft.AspNetCore.Components.Server.Circuits.CircuitRegistry">
\r
278 <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.CircuitRegistry"/> manages the lifetime of a <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHost"/>.
\r
281 Hosts start off by being registered using <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHost"/>.
\r
283 In the simplest of cases, the client disconnects e.g. the user is done with the application and closes the browser.
\r
284 The server (eventually) learns of the disconnect. The host is transitioned from <see cref="P:Microsoft.AspNetCore.Components.Server.Circuits.CircuitRegistry.ConnectedCircuits"/> to
\r
285 <see cref="P:Microsoft.AspNetCore.Components.Server.Circuits.CircuitRegistry.DisconnectedCircuits"/> where it sits with an expiration time. We'll mark the associated <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.CircuitClientProxy"/> as disconnected
\r
286 so that consumers of the Circuit know of the current state.
\r
287 Once the entry for the host in <see cref="P:Microsoft.AspNetCore.Components.Server.Circuits.CircuitRegistry.DisconnectedCircuits"/> expires, we'll dispose off the host.
\r
289 The alternate case is when the disconnect was transient, e.g. due to a network failure, and the client attempts to reconnect.
\r
290 We'll attempt to connect it back to the host and the preserved server state, when available. In this event, we do the opposite of
\r
291 what we did during disconnect - transition the host from <see cref="P:Microsoft.AspNetCore.Components.Server.Circuits.CircuitRegistry.DisconnectedCircuits"/> to <see cref="P:Microsoft.AspNetCore.Components.Server.Circuits.CircuitRegistry.ConnectedCircuits"/>, and transfer
\r
292 the <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.CircuitClientProxy"/> to use the new client instance that attempted to reconnect to the server. Removing the entry from
\r
293 <see cref="P:Microsoft.AspNetCore.Components.Server.Circuits.CircuitRegistry.DisconnectedCircuits"/> should ensure we no longer have to concern ourselves with entry expiration.
\r
295 Knowing when a client disconnected is not an exact science. There's a fair possiblity that a client may reconnect before the server realizes.
\r
296 Consequently, we have to account for reconnects and disconnects occuring simultaneously as well as appearing out of order.
\r
297 To manage this, we use a critical section to manage all state transitions.
\r
300 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.CircuitRegistry.Register(Microsoft.AspNetCore.Components.Server.Circuits.CircuitHost)">
\r
302 Registers an active <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.CircuitHost"/> with the register.
\r
305 <member name="T:Microsoft.AspNetCore.Components.Server.Circuits.RemoteNavigationManager">
\r
307 A Server-Side Blazor implementation of <see cref="T:Microsoft.AspNetCore.Components.NavigationManager"/>.
\r
310 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.RemoteNavigationManager.#ctor(Microsoft.Extensions.Logging.ILogger{Microsoft.AspNetCore.Components.Server.Circuits.RemoteNavigationManager})">
\r
312 Creates a new <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.RemoteNavigationManager"/> instance.
\r
314 <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger`1"/>.</param>
\r
316 <member name="P:Microsoft.AspNetCore.Components.Server.Circuits.RemoteNavigationManager.HasAttachedJSRuntime">
\r
318 Gets or sets whether the circuit has an attached <see cref="T:Microsoft.JSInterop.IJSRuntime"/>.
\r
321 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.RemoteNavigationManager.Initialize(System.String,System.String)">
\r
323 Initializes the <see cref="T:Microsoft.AspNetCore.Components.NavigationManager" />.
\r
325 <param name="baseUri">The base URI.</param>
\r
326 <param name="uri">The absolute URI.</param>
\r
328 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.RemoteNavigationManager.AttachJsRuntime(Microsoft.JSInterop.IJSRuntime)">
\r
330 Initializes the <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.RemoteNavigationManager"/>.
\r
332 <param name="jsRuntime">The <see cref="T:Microsoft.JSInterop.IJSRuntime"/> to use for interoperability.</param>
\r
334 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.RemoteNavigationManager.NavigateToCore(System.String,System.Boolean)">
\r
337 <member name="E:Microsoft.AspNetCore.Components.Server.Circuits.RemoteRenderer.UnhandledException">
\r
339 Notifies when a rendering exception occured.
\r
342 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.RemoteRenderer.#ctor(System.IServiceProvider,Microsoft.Extensions.Logging.ILoggerFactory,Microsoft.AspNetCore.Components.Server.CircuitOptions,Microsoft.AspNetCore.Components.Server.Circuits.CircuitClientProxy,Microsoft.Extensions.Logging.ILogger)">
\r
344 Creates a new <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.RemoteRenderer"/>.
\r
347 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.RemoteRenderer.AddComponentAsync(System.Type,System.String)">
\r
349 Associates the <see cref="T:Microsoft.AspNetCore.Components.IComponent"/> with the <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.RemoteRenderer"/>,
\r
350 causing it to be displayed in the specified DOM element.
\r
352 <param name="componentType">The type of the component.</param>
\r
353 <param name="domElementSelector">A CSS selector that uniquely identifies a DOM element.</param>
\r
355 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.RemoteRenderer.AddComponentAsync(System.Type,Microsoft.AspNetCore.Components.ParameterView,System.String)">
\r
357 Associates the <see cref="T:Microsoft.AspNetCore.Components.IComponent"/> with the <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.RemoteRenderer"/>,
\r
358 causing it to be displayed in the specified DOM element.
\r
360 <param name="componentType">The type of the component.</param>
\r
361 <param name="parameters">The parameters for the component.</param>
\r
362 <param name="domElementSelector">A CSS selector that uniquely identifies a DOM element.</param>
\r
364 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.RemoteRenderer.HandleException(System.Exception)">
\r
367 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.RemoteRenderer.Dispose(System.Boolean)">
\r
370 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.RemoteRenderer.UpdateDisplayAsync(Microsoft.AspNetCore.Components.RenderTree.RenderBatch@)">
\r
373 <member name="T:Microsoft.AspNetCore.Components.Server.Circuits.RenderBatchWriter">
\r
375 Provides a custom binary serializer for <see cref="T:Microsoft.AspNetCore.Components.RenderTree.RenderBatch"/> instances.
\r
376 This is designed with both server-side and client-side perf in mind:
\r
378 * Array-like regions always have a fixed size per entry (even if some entry types
\r
379 don't require as much space as others) so the recipient can index directly.
\r
380 * The indices describing where field data starts, where each string value starts,
\r
381 etc., are written *after* that data, so when writing the data we don't have to
\r
382 compute the locations up front or seek back to an earlier point in the stream.
\r
383 The recipient can only process the data after reading it all into a buffer,
\r
384 so it's no disadvantage for the location info to be at the end.
\r
385 * We only serialize the data that the JS side will need. For example, we don't
\r
386 emit frame sequence numbers, or any representation of nonstring attribute
\r
387 values, or component instances, etc.
\r
389 We don't have or need a .NET reader for this format. We only read it from JS code.
\r
392 <member name="T:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilder`1">
\r
394 Implements a list that uses an array of objects to store the elements.
\r
396 This differs from a <see cref="T:System.Collections.Generic.List`1"/> in that
\r
397 it not only grows as required but also shrinks if cleared with significant
\r
398 excess capacity. This makes it useful for component rendering, because
\r
399 components can be long-lived and re-render frequently, with the rendered size
\r
400 varying dramatically depending on the user's navigation in the app.
\r
403 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilder`1.#ctor(System.Int32,System.Buffers.ArrayPool{`0})">
\r
405 Constructs a new instance of <see cref="T:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilder`1"/>.
\r
408 <member name="P:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilder`1.Count">
\r
410 Gets the number of items.
\r
413 <member name="P:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilder`1.Buffer">
\r
415 Gets the underlying buffer.
\r
418 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilder`1.Append(`0@)">
\r
420 Appends a new item, automatically resizing the underlying array if necessary.
\r
422 <param name="item">The item to append.</param>
\r
423 <returns>The index of the appended item.</returns>
\r
425 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilder`1.Overwrite(System.Int32,`0@)">
\r
427 Sets the supplied value at the specified index. The index must be within
\r
428 range for the array.
\r
430 <param name="index">The index.</param>
\r
431 <param name="value">The value.</param>
\r
433 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilder`1.RemoveLast">
\r
435 Removes the last item.
\r
438 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilder`1.InsertExpensive(System.Int32,`0)">
\r
440 Inserts the item at the specified index, moving the contents of the subsequent entries along by one.
\r
442 <param name="index">The index at which the value is to be inserted.</param>
\r
443 <param name="value">The value to insert.</param>
\r
445 <member name="M:Microsoft.AspNetCore.Components.Server.Circuits.ArrayBuilder`1.Clear">
\r
447 Marks the array as empty, also shrinking the underlying storage if it was
\r
448 not being used to near its full capacity.
\r
451 <member name="T:Microsoft.AspNetCore.Components.Server.RevalidatingServerAuthenticationStateProvider">
\r
453 A base class for <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationStateProvider"/> services that receive an
\r
454 authentication state from the host environment, and revalidate it at regular intervals.
\r
457 <member name="M:Microsoft.AspNetCore.Components.Server.RevalidatingServerAuthenticationStateProvider.#ctor(Microsoft.Extensions.Logging.ILoggerFactory)">
\r
459 Constructs an instance of <see cref="T:Microsoft.AspNetCore.Components.Server.RevalidatingServerAuthenticationStateProvider"/>.
\r
461 <param name="loggerFactory">A logger factory.</param>
\r
463 <member name="P:Microsoft.AspNetCore.Components.Server.RevalidatingServerAuthenticationStateProvider.RevalidationInterval">
\r
465 Gets the interval between revalidation attempts.
\r
468 <member name="M:Microsoft.AspNetCore.Components.Server.RevalidatingServerAuthenticationStateProvider.ValidateAuthenticationStateAsync(Microsoft.AspNetCore.Components.Authorization.AuthenticationState,System.Threading.CancellationToken)">
\r
470 Determines whether the authentication state is still valid.
\r
472 <param name="authenticationState">The current <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationState"/>.</param>
\r
473 <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> to observe while performing the operation.</param>
\r
474 <returns>A <see cref="T:System.Threading.Tasks.Task"/> that resolves as true if the <paramref name="authenticationState"/> is still valid, or false if it is not.</returns>
\r
476 <member name="M:Microsoft.AspNetCore.Components.Server.RevalidatingServerAuthenticationStateProvider.Dispose(System.Boolean)">
\r
479 <member name="T:Microsoft.AspNetCore.Components.Server.ServerAuthenticationStateProvider">
\r
481 An <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationStateProvider"/> intended for use in server-side Blazor.
\r
484 <member name="M:Microsoft.AspNetCore.Components.Server.ServerAuthenticationStateProvider.GetAuthenticationStateAsync">
\r
487 <member name="M:Microsoft.AspNetCore.Components.Server.ServerAuthenticationStateProvider.SetAuthenticationState(System.Threading.Tasks.Task{Microsoft.AspNetCore.Components.Authorization.AuthenticationState})">
\r
490 <member name="P:Microsoft.AspNetCore.Components.Server.ComponentHub.DefaultPath">
\r
492 Gets the default endpoint path for incoming connections.
\r
495 <member name="T:Microsoft.AspNetCore.Builder.ComponentEndpointConventionBuilder">
\r
497 Builds conventions that will be used for customization of ComponentHub <see cref="T:Microsoft.AspNetCore.Builder.EndpointBuilder"/> instances.
\r
500 <member name="M:Microsoft.AspNetCore.Builder.ComponentEndpointConventionBuilder.Add(System.Action{Microsoft.AspNetCore.Builder.EndpointBuilder})">
\r
502 Adds the specified convention to the builder. Conventions are used to customize <see cref="T:Microsoft.AspNetCore.Builder.EndpointBuilder"/> instances.
\r
504 <param name="convention">The convention to add to the builder.</param>
\r
506 <member name="T:Microsoft.AspNetCore.Builder.ComponentEndpointRouteBuilderExtensions">
\r
508 Extensions for <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/>.
\r
511 <member name="M:Microsoft.AspNetCore.Builder.ComponentEndpointRouteBuilderExtensions.MapBlazorHub(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder)">
\r
513 Maps the Blazor <see cref="T:Microsoft.AspNetCore.SignalR.Hub" /> to the default path.
\r
515 <param name="endpoints">The <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/>.</param>
\r
516 <returns>The <see cref="T:Microsoft.AspNetCore.Builder.ComponentEndpointConventionBuilder"/>.</returns>
\r
518 <member name="M:Microsoft.AspNetCore.Builder.ComponentEndpointRouteBuilderExtensions.MapBlazorHub(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder,System.String)">
\r
520 Maps the Blazor <see cref="T:Microsoft.AspNetCore.SignalR.Hub" /> to the path <paramref name="path"/>.
\r
522 <param name="endpoints">The <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/>.</param>
\r
523 <param name="path">The path to map the Blazor <see cref="T:Microsoft.AspNetCore.SignalR.Hub" />.</param>
\r
524 <returns>The <see cref="T:Microsoft.AspNetCore.Builder.ComponentEndpointConventionBuilder"/>.</returns>
\r
526 <member name="M:Microsoft.AspNetCore.Builder.ComponentEndpointRouteBuilderExtensions.MapBlazorHub(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder,System.Action{Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions})">
\r
528 Maps the Blazor <see cref="T:Microsoft.AspNetCore.SignalR.Hub" /> to the default path.
\r
530 <param name="endpoints">The <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/>.</param>
\r
531 <param name="configureOptions">A callback to configure dispatcher options.</param>
\r
532 <returns>The <see cref="T:Microsoft.AspNetCore.Builder.ComponentEndpointConventionBuilder"/>.</returns>
\r
534 <member name="M:Microsoft.AspNetCore.Builder.ComponentEndpointRouteBuilderExtensions.MapBlazorHub(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder,System.String,System.Action{Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions})">
\r
536 Maps the Blazor <see cref="T:Microsoft.AspNetCore.SignalR.Hub" /> to the path <paramref name="path"/>.
\r
538 <param name="endpoints">The <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/>.</param>
\r
539 <param name="path">The path to map the Blazor <see cref="T:Microsoft.AspNetCore.SignalR.Hub" />.</param>
\r
540 <param name="configureOptions">A callback to configure dispatcher options.</param>
\r
541 <returns>The <see cref="T:Microsoft.AspNetCore.Builder.ComponentEndpointConventionBuilder"/>.</returns>
\r
543 <member name="T:Microsoft.AspNetCore.Internal.MemoryBufferWriter.CompletedBuffer">
\r
545 Holds a byte[] from the pool and a size value. Basically a Memory but guaranteed to be backed by an ArrayPool byte[], so that we know we can return it.
\r
548 <member name="T:Nerdbank.Streams.Sequence`1">
\r
550 Manages a sequence of elements, readily castable as a <see cref="T:System.Buffers.ReadOnlySequence`1"/>.
\r
552 <typeparam name="T">The type of element stored by the sequence.</typeparam>
\r
554 Instance members are not thread-safe.
\r
557 <member name="M:Nerdbank.Streams.Sequence`1.#ctor">
\r
559 Initializes a new instance of the <see cref="T:Nerdbank.Streams.Sequence`1"/> class
\r
560 that uses a private <see cref="T:System.Buffers.ArrayPool`1"/> for recycling arrays.
\r
563 <member name="M:Nerdbank.Streams.Sequence`1.#ctor(System.Buffers.MemoryPool{`0})">
\r
565 Initializes a new instance of the <see cref="T:Nerdbank.Streams.Sequence`1"/> class.
\r
567 <param name="memoryPool">The pool to use for recycling backing arrays.</param>
\r
569 <member name="M:Nerdbank.Streams.Sequence`1.#ctor(System.Buffers.ArrayPool{`0})">
\r
571 Initializes a new instance of the <see cref="T:Nerdbank.Streams.Sequence`1"/> class.
\r
573 <param name="arrayPool">The pool to use for recycling backing arrays.</param>
\r
575 <member name="P:Nerdbank.Streams.Sequence`1.MinimumSpanLength">
\r
577 Gets or sets the minimum length for any array allocated as a segment in the sequence.
\r
578 Any non-positive value allows the pool to determine the length of the array.
\r
580 <value>The default value is 0.</value>
\r
583 Each time <see cref="M:Nerdbank.Streams.Sequence`1.GetSpan(System.Int32)"/> or <see cref="M:Nerdbank.Streams.Sequence`1.GetMemory(System.Int32)"/> is called,
\r
584 previously allocated memory is used if it is large enough to satisfy the length demand.
\r
585 If new memory must be allocated, the argument to one of these methods typically dictate
\r
586 the length of array to allocate. When the caller uses very small values (just enough for its immediate need)
\r
587 but the high level scenario can predict that a large amount of memory will be ultimately required,
\r
588 it can be advisable to set this property to a value such that just a few larger arrays are allocated
\r
589 instead of many small ones.
\r
592 The <see cref="T:System.Buffers.MemoryPool`1"/> in use may itself have a minimum array length as well,
\r
593 in which case the higher of the two minimums dictate the minimum array size that will be allocated.
\r
597 <member name="P:Nerdbank.Streams.Sequence`1.AsReadOnlySequence">
\r
599 Gets this sequence expressed as a <see cref="T:System.Buffers.ReadOnlySequence`1"/>.
\r
601 <returns>A read only sequence representing the data in this object.</returns>
\r
603 <member name="P:Nerdbank.Streams.Sequence`1.Length">
\r
605 Gets the length of the sequence.
\r
608 <member name="P:Nerdbank.Streams.Sequence`1.DebuggerDisplay">
\r
610 Gets the value to display in a debugger datatip.
\r
613 <member name="M:Nerdbank.Streams.Sequence`1.op_Implicit(Nerdbank.Streams.Sequence{`0})~System.Buffers.ReadOnlySequence{`0}">
\r
615 Expresses this sequence as a <see cref="T:System.Buffers.ReadOnlySequence`1"/>.
\r
617 <param name="sequence">The sequence to convert.</param>
\r
619 <member name="M:Nerdbank.Streams.Sequence`1.AdvanceTo(System.SequencePosition)">
\r
621 Removes all elements from the sequence from its beginning to the specified position,
\r
622 considering that data to have been fully processed.
\r
624 <param name="position">
\r
625 The position of the first element that has not yet been processed.
\r
626 This is typically <see cref="P:System.Buffers.ReadOnlySequence`1.End"/> after reading all elements from that instance.
\r
629 <member name="M:Nerdbank.Streams.Sequence`1.Advance(System.Int32)">
\r
631 Advances the sequence to include the specified number of elements initialized into memory
\r
632 returned by a prior call to <see cref="M:Nerdbank.Streams.Sequence`1.GetMemory(System.Int32)"/>.
\r
634 <param name="count">The number of elements written into memory.</param>
\r
636 <member name="M:Nerdbank.Streams.Sequence`1.GetMemory(System.Int32)">
\r
638 Gets writable memory that can be initialized and added to the sequence via a subsequent call to <see cref="M:Nerdbank.Streams.Sequence`1.Advance(System.Int32)"/>.
\r
640 <param name="sizeHint">The size of the memory required, or 0 to just get a convenient (non-empty) buffer.</param>
\r
641 <returns>The requested memory.</returns>
\r
643 <member name="M:Nerdbank.Streams.Sequence`1.GetSpan(System.Int32)">
\r
645 Gets writable memory that can be initialized and added to the sequence via a subsequent call to <see cref="M:Nerdbank.Streams.Sequence`1.Advance(System.Int32)"/>.
\r
647 <param name="sizeHint">The size of the memory required, or 0 to just get a convenient (non-empty) buffer.</param>
\r
648 <returns>The requested memory.</returns>
\r
650 <member name="M:Nerdbank.Streams.Sequence`1.Dispose">
\r
652 Clears the entire sequence, recycles associated memory into pools,
\r
653 and resets this instance for reuse.
\r
654 This invalidates any <see cref="T:System.Buffers.ReadOnlySequence`1"/> previously produced by this instance.
\r
657 <member name="M:Nerdbank.Streams.Sequence`1.Reset">
\r
659 Clears the entire sequence and recycles associated memory into pools.
\r
660 This invalidates any <see cref="T:System.Buffers.ReadOnlySequence`1"/> previously produced by this instance.
\r
663 <member name="F:Nerdbank.Streams.Sequence`1.SequenceSegment.IsValueTypeElement">
\r
665 A value indicating whether the element is a value type.
\r
668 <member name="F:Nerdbank.Streams.Sequence`1.SequenceSegment.array">
\r
670 Gets the backing array, when using an <see cref="T:System.Buffers.ArrayPool`1"/> instead of a <see cref="T:System.Buffers.MemoryPool`1"/>.
\r
673 <member name="P:Nerdbank.Streams.Sequence`1.SequenceSegment.Start">
\r
675 Gets the position within <see cref="P:System.Buffers.ReadOnlySequenceSegment`1.Memory"/> where the data starts.
\r
677 <remarks>This may be nonzero as a result of calling <see cref="M:Nerdbank.Streams.Sequence`1.AdvanceTo(System.SequencePosition)"/>.</remarks>
\r
679 <member name="P:Nerdbank.Streams.Sequence`1.SequenceSegment.End">
\r
681 Gets the position within <see cref="P:System.Buffers.ReadOnlySequenceSegment`1.Memory"/> where the data ends.
\r
684 <member name="P:Nerdbank.Streams.Sequence`1.SequenceSegment.RemainingMemory">
\r
686 Gets the tail of memory that has not yet been committed.
\r
689 <member name="P:Nerdbank.Streams.Sequence`1.SequenceSegment.RemainingSpan">
\r
691 Gets the tail of memory that has not yet been committed.
\r
694 <member name="P:Nerdbank.Streams.Sequence`1.SequenceSegment.MemoryOwner">
\r
696 Gets the tracker for the underlying array for this segment, which can be used to recycle the array when we're disposed of.
\r
697 Will be <c>null</c> if using an array pool, in which case the memory is held by <see cref="F:Nerdbank.Streams.Sequence`1.SequenceSegment.array"/>.
\r
700 <member name="P:Nerdbank.Streams.Sequence`1.SequenceSegment.AvailableMemory">
\r
702 Gets the full memory owned by the <see cref="P:Nerdbank.Streams.Sequence`1.SequenceSegment.MemoryOwner"/>.
\r
705 <member name="P:Nerdbank.Streams.Sequence`1.SequenceSegment.Length">
\r
707 Gets the number of elements that are committed in this segment.
\r
710 <member name="P:Nerdbank.Streams.Sequence`1.SequenceSegment.WritableBytes">
\r
712 Gets the amount of writable bytes in this segment.
\r
713 It is the amount of bytes between <see cref="P:Nerdbank.Streams.Sequence`1.SequenceSegment.Length"/> and <see cref="P:Nerdbank.Streams.Sequence`1.SequenceSegment.End"/>.
\r
716 <member name="P:Nerdbank.Streams.Sequence`1.SequenceSegment.Next">
\r
718 Gets or sets the next segment in the singly linked list of segments.
\r
721 <member name="M:Nerdbank.Streams.Sequence`1.SequenceSegment.Assign(System.Buffers.IMemoryOwner{`0})">
\r
723 Assigns this (recyclable) segment a new area in memory.
\r
725 <param name="memoryOwner">The memory and a means to recycle it.</param>
\r
727 <member name="M:Nerdbank.Streams.Sequence`1.SequenceSegment.Assign(`0[])">
\r
729 Assigns this (recyclable) segment a new area in memory.
\r
731 <param name="array">An array drawn from an <see cref="T:System.Buffers.ArrayPool`1"/>.</param>
\r
733 <member name="M:Nerdbank.Streams.Sequence`1.SequenceSegment.ResetMemory(System.Buffers.ArrayPool{`0})">
\r
735 Clears all fields in preparation to recycle this instance.
\r
738 <member name="M:Nerdbank.Streams.Sequence`1.SequenceSegment.SetNext(Nerdbank.Streams.Sequence{`0}.SequenceSegment)">
\r
740 Adds a new segment after this one.
\r
742 <param name="segment">The next segment in the linked list.</param>
\r
744 <member name="M:Nerdbank.Streams.Sequence`1.SequenceSegment.Advance(System.Int32)">
\r
746 Commits more elements as written in this segment.
\r
748 <param name="count">The number of elements written.</param>
\r
750 <member name="M:Nerdbank.Streams.Sequence`1.SequenceSegment.AdvanceTo(System.Int32)">
\r
752 Removes some elements from the start of this segment.
\r
754 <param name="offset">The number of elements to ignore from the start of the underlying array.</param>
\r
756 <member name="T:MessagePack.BufferWriter">
\r
758 A fast access struct that wraps <see cref="T:System.Buffers.IBufferWriter`1"/>.
\r
761 <member name="F:MessagePack.BufferWriter._output">
\r
763 The underlying <see cref="T:System.Buffers.IBufferWriter`1"/>.
\r
766 <member name="F:MessagePack.BufferWriter._span">
\r
768 The result of the last call to <see cref="M:System.Buffers.IBufferWriter`1.GetSpan(System.Int32)"/>, less any bytes already "consumed" with <see cref="M:MessagePack.BufferWriter.Advance(System.Int32)"/>.
\r
769 Backing field for the <see cref="P:MessagePack.BufferWriter.Span"/> property.
\r
772 <member name="F:MessagePack.BufferWriter._segment">
\r
774 The result of the last call to <see cref="M:System.Buffers.IBufferWriter`1.GetMemory(System.Int32)"/>, less any bytes already "consumed" with <see cref="M:MessagePack.BufferWriter.Advance(System.Int32)"/>.
\r
777 <member name="F:MessagePack.BufferWriter._buffered">
\r
779 The number of uncommitted bytes (all the calls to <see cref="M:MessagePack.BufferWriter.Advance(System.Int32)"/> since the last call to <see cref="M:MessagePack.BufferWriter.Commit"/>).
\r
782 <member name="F:MessagePack.BufferWriter._bytesCommitted">
\r
784 The total number of bytes written with this writer.
\r
785 Backing field for the <see cref="P:MessagePack.BufferWriter.BytesCommitted"/> property.
\r
788 <member name="M:MessagePack.BufferWriter.#ctor(System.Buffers.IBufferWriter{System.Byte})">
\r
790 Initializes a new instance of the <see cref="T:MessagePack.BufferWriter"/> struct.
\r
792 <param name="output">The <see cref="T:System.Buffers.IBufferWriter`1"/> to be wrapped.</param>
\r
794 <member name="M:MessagePack.BufferWriter.#ctor(MessagePack.SequencePool,System.Byte[])">
\r
796 Initializes a new instance of the <see cref="T:MessagePack.BufferWriter"/> struct.
\r
798 <param name="sequencePool">The pool from which to draw an <see cref="T:System.Buffers.IBufferWriter`1"/> if required..</param>
\r
799 <param name="array">An array to start with so we can avoid accessing the <paramref name="sequencePool"/> if possible.</param>
\r
801 <member name="P:MessagePack.BufferWriter.Span">
\r
803 Gets the result of the last call to <see cref="M:System.Buffers.IBufferWriter`1.GetSpan(System.Int32)"/>.
\r
806 <member name="P:MessagePack.BufferWriter.BytesCommitted">
\r
808 Gets the total number of bytes written with this writer.
\r
811 <member name="P:MessagePack.BufferWriter.UnderlyingWriter">
\r
813 Gets the <see cref="T:System.Buffers.IBufferWriter`1"/> underlying this instance.
\r
816 <member name="M:MessagePack.BufferWriter.Commit">
\r
818 Calls <see cref="M:System.Buffers.IBufferWriter`1.Advance(System.Int32)"/> on the underlying writer
\r
819 with the number of uncommitted bytes.
\r
822 <member name="M:MessagePack.BufferWriter.Advance(System.Int32)">
\r
824 Used to indicate that part of the buffer has been written to.
\r
826 <param name="count">The number of bytes written to.</param>
\r
828 <member name="M:MessagePack.BufferWriter.Write(System.ReadOnlySpan{System.Byte})">
\r
830 Copies the caller's buffer into this writer and calls <see cref="M:MessagePack.BufferWriter.Advance(System.Int32)"/> with the length of the source buffer.
\r
832 <param name="source">The buffer to copy in.</param>
\r
834 <member name="M:MessagePack.BufferWriter.Ensure(System.Int32)">
\r
836 Acquires a new buffer if necessary to ensure that some given number of bytes can be written to a single buffer.
\r
838 <param name="count">The number of bytes that must be allocated in a single buffer.</param>
\r
840 <member name="M:MessagePack.BufferWriter.TryGetUncommittedSpan(System.ReadOnlySpan{System.Byte}@)">
\r
842 Gets the span to the bytes written if they were never committed to the underlying buffer writer.
\r
844 <param name="span"></param>
\r
845 <returns></returns>
\r
847 <member name="M:MessagePack.BufferWriter.EnsureMore(System.Int32)">
\r
849 Gets a fresh span to write to, with an optional minimum size.
\r
851 <param name="count">The minimum size for the next requested buffer.</param>
\r
853 <member name="M:MessagePack.BufferWriter.WriteMultiBuffer(System.ReadOnlySpan{System.Byte})">
\r
855 Copies the caller's buffer into this writer, potentially across multiple buffers from the underlying writer.
\r
857 <param name="source">The buffer to copy into this writer.</param>
\r
859 <member name="T:MessagePack.MessagePackType">
\r
861 https://github.com/msgpack/msgpack/blob/master/spec.md#serialization-type-to-format-conversion
\r
864 <member name="T:MessagePack.MessagePackCode">
\r
866 https://github.com/msgpack/msgpack/blob/master/spec.md#overview
\r
869 <member name="M:MessagePack.MessagePackCode.IsSignedInteger(System.Byte)">
\r
871 Checks whether a given messagepack code represents an integer that might include a sign (i.e. might be a negative number).
\r
873 <param name="code">The messagepack code.</param>
\r
874 <returns>A boolean value.</returns>
\r
876 <member name="T:MessagePack.MessagePackReader">
\r
878 A primitive types reader for the MessagePack format.
\r
881 <see href="https://github.com/msgpack/msgpack/blob/master/spec.md">The MessagePack spec.</see>
\r
884 <member name="F:MessagePack.MessagePackReader.reader">
\r
886 The reader over the sequence.
\r
889 <member name="M:MessagePack.MessagePackReader.#ctor(System.ReadOnlyMemory{System.Byte})">
\r
891 Initializes a new instance of the <see cref="T:MessagePack.MessagePackReader"/> struct.
\r
893 <param name="memory">The buffer to read from.</param>
\r
895 <member name="M:MessagePack.MessagePackReader.#ctor(System.Buffers.ReadOnlySequence{System.Byte})">
\r
897 Initializes a new instance of the <see cref="T:MessagePack.MessagePackReader"/> struct.
\r
899 <param name="readOnlySequence">The sequence to read from.</param>
\r
901 <member name="P:MessagePack.MessagePackReader.Sequence">
\r
903 Gets the <see cref="T:System.Buffers.ReadOnlySequence`1"/> originally supplied to the constructor.
\r
906 <member name="P:MessagePack.MessagePackReader.Position">
\r
908 Gets the current position of the reader within <see cref="P:MessagePack.MessagePackReader.Sequence"/>.
\r
911 <member name="P:MessagePack.MessagePackReader.Consumed">
\r
913 Gets the number of bytes consumed by the reader.
\r
916 <member name="P:MessagePack.MessagePackReader.End">
\r
918 Gets a value indicating whether the reader is at the end of the sequence.
\r
921 <member name="P:MessagePack.MessagePackReader.IsNil">
\r
923 Checks whether the reader position is pointing at a nil value.
\r
925 <exception cref="T:System.IO.EndOfStreamException">Thrown if the end of the sequence provided to the constructor is reached before the expected end of the data.</exception>
\r
927 <member name="P:MessagePack.MessagePackReader.NextMessagePackType">
\r
929 Gets the next message pack type to be read.
\r
932 <member name="P:MessagePack.MessagePackReader.NextCode">
\r
934 Gets the type of the next MessagePack block.
\r
936 <exception cref="T:System.IO.EndOfStreamException">Thrown if the end of the sequence provided to the constructor is reached before the expected end of the data.</exception>
\r
938 See <see cref="T:MessagePack.MessagePackCode"/> for valid message pack codes and ranges.
\r
941 <member name="M:MessagePack.MessagePackReader.Clone(System.Buffers.ReadOnlySequence{System.Byte})">
\r
943 Initializes a new instance of the <see cref="T:MessagePack.MessagePackReader"/> struct,
\r
944 with the same settings as this one, but with its own buffer to read from.
\r
946 <param name="readOnlySequence">The sequence to read from.</param>
\r
947 <returns>The new reader.</returns>
\r
949 <member name="M:MessagePack.MessagePackReader.CreatePeekReader">
\r
951 Creates a new <see cref="T:MessagePack.MessagePackReader"/> at this reader's current position.
\r
952 The two readers may then be used independently without impacting each other.
\r
954 <returns>A new <see cref="T:MessagePack.MessagePackReader"/>.</returns>
\r
956 <member name="M:MessagePack.MessagePackReader.Skip">
\r
958 Advances the reader to the next MessagePack primitive to be read.
\r
961 The entire primitive is skipped, including content of maps or arrays, or any other type with payloads.
\r
964 <member name="M:MessagePack.MessagePackReader.ReadNil">
\r
966 Reads a <see cref="F:MessagePack.MessagePackCode.Nil"/> value.
\r
968 <returns>A nil value.</returns>
\r
970 <member name="M:MessagePack.MessagePackReader.TryReadNil">
\r
972 Reads nil if it is the next token.
\r
974 <returns><c>true</c> if the next token was nil; <c>false</c> otherwise.</returns>
\r
976 <member name="M:MessagePack.MessagePackReader.ReadRaw(System.Int64)">
\r
978 Reads a sequence of bytes without any decoding.
\r
980 <param name="length">The number of bytes to read.</param>
\r
981 <returns>The sequence of bytes read.</returns>
\r
983 <member name="M:MessagePack.MessagePackReader.ReadArrayHeader">
\r
985 Read an array header from
\r
986 <see cref="F:MessagePack.MessagePackCode.Array16"/>,
\r
987 <see cref="F:MessagePack.MessagePackCode.Array32"/>, or
\r
988 some built-in code between <see cref="F:MessagePack.MessagePackCode.MinFixArray"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixArray"/>.
\r
991 <member name="M:MessagePack.MessagePackReader.ReadMapHeader">
\r
993 Read a map header from
\r
994 <see cref="F:MessagePack.MessagePackCode.Map16"/>,
\r
995 <see cref="F:MessagePack.MessagePackCode.Map32"/>, or
\r
996 some built-in code between <see cref="F:MessagePack.MessagePackCode.MinFixMap"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixMap"/>.
\r
999 <member name="M:MessagePack.MessagePackReader.ReadBoolean">
\r
1001 Reads a boolean value from either a <see cref="F:MessagePack.MessagePackCode.False"/> or <see cref="F:MessagePack.MessagePackCode.True"/>.
\r
1003 <returns>The value.</returns>
\r
1005 <member name="M:MessagePack.MessagePackReader.ReadChar">
\r
1007 Reads a <see cref="T:System.Char"/> from any of:
\r
1008 <see cref="F:MessagePack.MessagePackCode.UInt8"/>,
\r
1009 <see cref="F:MessagePack.MessagePackCode.UInt16"/>,
\r
1010 or anything between <see cref="F:MessagePack.MessagePackCode.MinFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixInt"/>.
\r
1012 <returns>A character.</returns>
\r
1014 <member name="M:MessagePack.MessagePackReader.ReadSingle">
\r
1016 Reads an <see cref="T:System.Single"/> value from any value encoded with:
\r
1017 <see cref="F:MessagePack.MessagePackCode.Float32"/>,
\r
1018 <see cref="F:MessagePack.MessagePackCode.Int8"/>,
\r
1019 <see cref="F:MessagePack.MessagePackCode.Int16"/>,
\r
1020 <see cref="F:MessagePack.MessagePackCode.Int32"/>,
\r
1021 <see cref="F:MessagePack.MessagePackCode.Int64"/>,
\r
1022 <see cref="F:MessagePack.MessagePackCode.UInt8"/>,
\r
1023 <see cref="F:MessagePack.MessagePackCode.UInt16"/>,
\r
1024 <see cref="F:MessagePack.MessagePackCode.UInt32"/>,
\r
1025 <see cref="F:MessagePack.MessagePackCode.UInt64"/>,
\r
1026 or some value between <see cref="F:MessagePack.MessagePackCode.MinNegativeFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxNegativeFixInt"/>,
\r
1027 or some value between <see cref="F:MessagePack.MessagePackCode.MinFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixInt"/>.
\r
1029 <returns>The value.</returns>
\r
1031 <member name="M:MessagePack.MessagePackReader.ReadDouble">
\r
1033 Reads an <see cref="T:System.Double"/> value from any value encoded with:
\r
1034 <see cref="F:MessagePack.MessagePackCode.Float64"/>,
\r
1035 <see cref="F:MessagePack.MessagePackCode.Float32"/>,
\r
1036 <see cref="F:MessagePack.MessagePackCode.Int8"/>,
\r
1037 <see cref="F:MessagePack.MessagePackCode.Int16"/>,
\r
1038 <see cref="F:MessagePack.MessagePackCode.Int32"/>,
\r
1039 <see cref="F:MessagePack.MessagePackCode.Int64"/>,
\r
1040 <see cref="F:MessagePack.MessagePackCode.UInt8"/>,
\r
1041 <see cref="F:MessagePack.MessagePackCode.UInt16"/>,
\r
1042 <see cref="F:MessagePack.MessagePackCode.UInt32"/>,
\r
1043 <see cref="F:MessagePack.MessagePackCode.UInt64"/>,
\r
1044 or some value between <see cref="F:MessagePack.MessagePackCode.MinNegativeFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxNegativeFixInt"/>,
\r
1045 or some value between <see cref="F:MessagePack.MessagePackCode.MinFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixInt"/>.
\r
1047 <returns>The value.</returns>
\r
1049 <member name="M:MessagePack.MessagePackReader.ReadDateTime">
\r
1051 Reads a <see cref="T:System.DateTime"/> from a value encoded with
\r
1052 <see cref="F:MessagePack.MessagePackCode.FixExt4"/>,
\r
1053 <see cref="F:MessagePack.MessagePackCode.FixExt8"/>, or
\r
1054 <see cref="F:MessagePack.MessagePackCode.Ext8"/>.
\r
1055 Expects extension type code <see cref="F:MessagePack.ReservedMessagePackExtensionTypeCode.DateTime"/>.
\r
1057 <returns>The value.</returns>
\r
1059 <member name="M:MessagePack.MessagePackReader.ReadDateTime(MessagePack.ExtensionHeader)">
\r
1061 Reads a <see cref="T:System.DateTime"/> from a value encoded with
\r
1062 <see cref="F:MessagePack.MessagePackCode.FixExt4"/>,
\r
1063 <see cref="F:MessagePack.MessagePackCode.FixExt8"/>,
\r
1064 <see cref="F:MessagePack.MessagePackCode.Ext8"/>.
\r
1065 Expects extension type code <see cref="F:MessagePack.ReservedMessagePackExtensionTypeCode.DateTime"/>.
\r
1067 <param name="header">The extension header that was already read.</param>
\r
1068 <returns>The value.</returns>
\r
1070 <member name="M:MessagePack.MessagePackReader.ReadBytes">
\r
1072 Reads a span of bytes, whose length is determined by a header of one of these types:
\r
1073 <see cref="F:MessagePack.MessagePackCode.Bin8"/>,
\r
1074 <see cref="F:MessagePack.MessagePackCode.Bin16"/>,
\r
1075 <see cref="F:MessagePack.MessagePackCode.Bin32"/>,
\r
1076 or to support OldSpec compatibility:
\r
1077 <see cref="F:MessagePack.MessagePackCode.Str16"/>,
\r
1078 <see cref="F:MessagePack.MessagePackCode.Str32"/>,
\r
1079 or something beteween <see cref="F:MessagePack.MessagePackCode.MinFixStr"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixStr"/>.
\r
1082 A sequence of bytes.
\r
1083 The data is a slice from the original sequence passed to this reader's constructor.
\r
1086 <member name="M:MessagePack.MessagePackReader.ReadStringSegment">
\r
1088 Reads a string of bytes, whose length is determined by a header of one of these types:
\r
1089 <see cref="F:MessagePack.MessagePackCode.Str8"/>,
\r
1090 <see cref="F:MessagePack.MessagePackCode.Str16"/>,
\r
1091 <see cref="F:MessagePack.MessagePackCode.Str32"/>,
\r
1092 or a code between <see cref="F:MessagePack.MessagePackCode.MinFixStr"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixStr"/>.
\r
1095 The sequence of bytes.
\r
1096 The data is a slice from the original sequence passed to this reader's constructor.
\r
1099 <member name="M:MessagePack.MessagePackReader.ReadString">
\r
1101 Reads a string, whose length is determined by a header of one of these types:
\r
1102 <see cref="F:MessagePack.MessagePackCode.Str8"/>,
\r
1103 <see cref="F:MessagePack.MessagePackCode.Str16"/>,
\r
1104 <see cref="F:MessagePack.MessagePackCode.Str32"/>,
\r
1105 or a code between <see cref="F:MessagePack.MessagePackCode.MinFixStr"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixStr"/>.
\r
1107 <returns>A string.</returns>
\r
1109 <member name="M:MessagePack.MessagePackReader.ReadExtensionFormatHeader">
\r
1111 Reads an extension format header, based on one of these codes:
\r
1112 <see cref="F:MessagePack.MessagePackCode.FixExt1"/>,
\r
1113 <see cref="F:MessagePack.MessagePackCode.FixExt2"/>,
\r
1114 <see cref="F:MessagePack.MessagePackCode.FixExt4"/>,
\r
1115 <see cref="F:MessagePack.MessagePackCode.FixExt8"/>,
\r
1116 <see cref="F:MessagePack.MessagePackCode.FixExt16"/>,
\r
1117 <see cref="F:MessagePack.MessagePackCode.Ext8"/>,
\r
1118 <see cref="F:MessagePack.MessagePackCode.Ext16"/>, or
\r
1119 <see cref="F:MessagePack.MessagePackCode.Ext32"/>.
\r
1121 <returns>The extension header.</returns>
\r
1123 <member name="M:MessagePack.MessagePackReader.ReadExtensionFormat">
\r
1125 Reads an extension format header and data, based on one of these codes:
\r
1126 <see cref="F:MessagePack.MessagePackCode.FixExt1"/>,
\r
1127 <see cref="F:MessagePack.MessagePackCode.FixExt2"/>,
\r
1128 <see cref="F:MessagePack.MessagePackCode.FixExt4"/>,
\r
1129 <see cref="F:MessagePack.MessagePackCode.FixExt8"/>,
\r
1130 <see cref="F:MessagePack.MessagePackCode.FixExt16"/>,
\r
1131 <see cref="F:MessagePack.MessagePackCode.Ext8"/>,
\r
1132 <see cref="F:MessagePack.MessagePackCode.Ext16"/>, or
\r
1133 <see cref="F:MessagePack.MessagePackCode.Ext32"/>.
\r
1136 The extension format.
\r
1137 The data is a slice from the original sequence passed to this reader's constructor.
\r
1140 <member name="M:MessagePack.MessagePackReader.ThrowInsufficientBufferUnless(System.Boolean)">
\r
1142 Throws <see cref="T:System.IO.EndOfStreamException"/> if a condition is false.
\r
1144 <param name="condition">A boolean value.</param>
\r
1145 <exception cref="T:System.IO.EndOfStreamException">Thrown if <paramref name="condition"/> is <c>false</c>.</exception>
\r
1147 <member name="M:MessagePack.MessagePackReader.GetStringLengthInBytes">
\r
1149 Gets the length of the next string.
\r
1151 <returns>The length of the next string.</returns>
\r
1153 <member name="M:MessagePack.MessagePackReader.ReadStringSlow(System.Int32)">
\r
1155 Reads a string assuming that it is spread across multiple spans in the <see cref="T:System.Buffers.ReadOnlySequence`1"/>.
\r
1157 <param name="byteLength">The length of the string to be decoded, in bytes.</param>
\r
1158 <returns>The decoded string.</returns>
\r
1160 <member name="M:MessagePack.MessagePackReader.ReadByte">
\r
1162 Reads an <see cref="T:System.Byte"/> value from:
\r
1163 Some value between <see cref="F:MessagePack.MessagePackCode.MinNegativeFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxNegativeFixInt"/>,
\r
1164 Some value between <see cref="F:MessagePack.MessagePackCode.MinFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixInt"/>,
\r
1165 or any of the other MsgPack integer types.
\r
1167 <returns>The value.</returns>
\r
1168 <exception cref="T:System.OverflowException">Thrown when the value exceeds what can be stored in the returned type.</exception>
\r
1170 <member name="M:MessagePack.MessagePackReader.ReadUInt16">
\r
1172 Reads an <see cref="T:System.UInt16"/> value from:
\r
1173 Some value between <see cref="F:MessagePack.MessagePackCode.MinNegativeFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxNegativeFixInt"/>,
\r
1174 Some value between <see cref="F:MessagePack.MessagePackCode.MinFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixInt"/>,
\r
1175 or any of the other MsgPack integer types.
\r
1177 <returns>The value.</returns>
\r
1178 <exception cref="T:System.OverflowException">Thrown when the value exceeds what can be stored in the returned type.</exception>
\r
1180 <member name="M:MessagePack.MessagePackReader.ReadUInt32">
\r
1182 Reads an <see cref="T:System.UInt32"/> value from:
\r
1183 Some value between <see cref="F:MessagePack.MessagePackCode.MinNegativeFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxNegativeFixInt"/>,
\r
1184 Some value between <see cref="F:MessagePack.MessagePackCode.MinFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixInt"/>,
\r
1185 or any of the other MsgPack integer types.
\r
1187 <returns>The value.</returns>
\r
1188 <exception cref="T:System.OverflowException">Thrown when the value exceeds what can be stored in the returned type.</exception>
\r
1190 <member name="M:MessagePack.MessagePackReader.ReadUInt64">
\r
1192 Reads an <see cref="T:System.UInt64"/> value from:
\r
1193 Some value between <see cref="F:MessagePack.MessagePackCode.MinNegativeFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxNegativeFixInt"/>,
\r
1194 Some value between <see cref="F:MessagePack.MessagePackCode.MinFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixInt"/>,
\r
1195 or any of the other MsgPack integer types.
\r
1197 <returns>The value.</returns>
\r
1198 <exception cref="T:System.OverflowException">Thrown when the value exceeds what can be stored in the returned type.</exception>
\r
1200 <member name="M:MessagePack.MessagePackReader.ReadSByte">
\r
1202 Reads an <see cref="T:System.SByte"/> value from:
\r
1203 Some value between <see cref="F:MessagePack.MessagePackCode.MinNegativeFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxNegativeFixInt"/>,
\r
1204 Some value between <see cref="F:MessagePack.MessagePackCode.MinFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixInt"/>,
\r
1205 or any of the other MsgPack integer types.
\r
1207 <returns>The value.</returns>
\r
1208 <exception cref="T:System.OverflowException">Thrown when the value exceeds what can be stored in the returned type.</exception>
\r
1210 <member name="M:MessagePack.MessagePackReader.ReadInt16">
\r
1212 Reads an <see cref="T:System.Int16"/> value from:
\r
1213 Some value between <see cref="F:MessagePack.MessagePackCode.MinNegativeFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxNegativeFixInt"/>,
\r
1214 Some value between <see cref="F:MessagePack.MessagePackCode.MinFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixInt"/>,
\r
1215 or any of the other MsgPack integer types.
\r
1217 <returns>The value.</returns>
\r
1218 <exception cref="T:System.OverflowException">Thrown when the value exceeds what can be stored in the returned type.</exception>
\r
1220 <member name="M:MessagePack.MessagePackReader.ReadInt32">
\r
1222 Reads an <see cref="T:System.Int32"/> value from:
\r
1223 Some value between <see cref="F:MessagePack.MessagePackCode.MinNegativeFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxNegativeFixInt"/>,
\r
1224 Some value between <see cref="F:MessagePack.MessagePackCode.MinFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixInt"/>,
\r
1225 or any of the other MsgPack integer types.
\r
1227 <returns>The value.</returns>
\r
1228 <exception cref="T:System.OverflowException">Thrown when the value exceeds what can be stored in the returned type.</exception>
\r
1230 <member name="M:MessagePack.MessagePackReader.ReadInt64">
\r
1232 Reads an <see cref="T:System.Int64"/> value from:
\r
1233 Some value between <see cref="F:MessagePack.MessagePackCode.MinNegativeFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxNegativeFixInt"/>,
\r
1234 Some value between <see cref="F:MessagePack.MessagePackCode.MinFixInt"/> and <see cref="F:MessagePack.MessagePackCode.MaxFixInt"/>,
\r
1235 or any of the other MsgPack integer types.
\r
1237 <returns>The value.</returns>
\r
1238 <exception cref="T:System.OverflowException">Thrown when the value exceeds what can be stored in the returned type.</exception>
\r
1240 <member name="T:MessagePack.MessagePackWriter">
\r
1242 A primitive types writer for the MessagePack format.
\r
1245 <see href="https://github.com/msgpack/msgpack/blob/master/spec.md">The MessagePack spec.</see>
\r
1248 <member name="F:MessagePack.MessagePackWriter.writer">
\r
1250 The writer to use.
\r
1253 <member name="M:MessagePack.MessagePackWriter.#ctor(System.Buffers.IBufferWriter{System.Byte})">
\r
1255 Initializes a new instance of the <see cref="T:MessagePack.MessagePackWriter"/> struct.
\r
1257 <param name="writer">The writer to use.</param>
\r
1259 <member name="M:MessagePack.MessagePackWriter.#ctor(MessagePack.SequencePool,System.Byte[])">
\r
1261 Initializes a new instance of the <see cref="T:MessagePack.MessagePackWriter"/> struct.
\r
1264 <member name="P:MessagePack.MessagePackWriter.OldSpec">
\r
1266 Gets or sets a value indicating whether to write in <see href="https://github.com/msgpack/msgpack/blob/master/spec-old.md">old spec</see> compatibility mode.
\r
1269 <member name="M:MessagePack.MessagePackWriter.Clone(System.Buffers.IBufferWriter{System.Byte})">
\r
1271 Initializes a new instance of the <see cref="T:MessagePack.MessagePackWriter"/> struct,
\r
1272 with the same settings as this one, but with its own buffer writer.
\r
1274 <param name="writer">The writer to use for the new instance.</param>
\r
1275 <returns>The new writer.</returns>
\r
1277 <member name="M:MessagePack.MessagePackWriter.Flush">
\r
1279 Ensures everything previously written has been flushed to the underlying <see cref="T:System.Buffers.IBufferWriter`1"/>.
\r
1282 <member name="M:MessagePack.MessagePackWriter.WriteNil">
\r
1284 Writes a <see cref="F:MessagePack.MessagePackCode.Nil"/> value.
\r
1287 <member name="M:MessagePack.MessagePackWriter.WriteRaw(System.ReadOnlySpan{System.Byte})">
\r
1289 Copies bytes directly into the message pack writer.
\r
1291 <param name="rawMessagePackBlock">The span of bytes to copy from.</param>
\r
1293 <member name="M:MessagePack.MessagePackWriter.WriteRaw(System.Buffers.ReadOnlySequence{System.Byte})">
\r
1295 Copies bytes directly into the message pack writer.
\r
1297 <param name="rawMessagePackBlock">The span of bytes to copy from.</param>
\r
1299 <member name="M:MessagePack.MessagePackWriter.WriteArrayHeader(System.Int32)">
\r
1301 Write the length of the next array to be written in the most compact form of
\r
1302 <see cref="F:MessagePack.MessagePackCode.MinFixArray"/>,
\r
1303 <see cref="F:MessagePack.MessagePackCode.Array16"/>, or
\r
1304 <see cref="F:MessagePack.MessagePackCode.Array32"/>
\r
1306 <param name="count">The number of elements that will be written in the array.</param>
\r
1308 <member name="M:MessagePack.MessagePackWriter.WriteArrayHeader(System.UInt32)">
\r
1310 Write the length of the next array to be written in the most compact form of
\r
1311 <see cref="F:MessagePack.MessagePackCode.MinFixArray"/>,
\r
1312 <see cref="F:MessagePack.MessagePackCode.Array16"/>, or
\r
1313 <see cref="F:MessagePack.MessagePackCode.Array32"/>
\r
1315 <param name="count">The number of elements that will be written in the array.</param>
\r
1317 <member name="M:MessagePack.MessagePackWriter.WriteFixedArrayHeaderUnsafe(System.UInt32)">
\r
1319 Write the length of the next array to be written as <see cref="F:MessagePack.MessagePackCode.MinFixArray"/>.
\r
1321 <param name="count">
\r
1322 The number of elements that will be written in the array. This MUST be less than <see cref="F:MessagePack.MessagePackRange.MaxFixArrayCount"/>.
\r
1323 This condition is NOT checked within this method, and violating this rule will result in data corruption.
\r
1326 <member name="M:MessagePack.MessagePackWriter.WriteMapHeader(System.Int32)">
\r
1328 Write the length of the next map to be written in the most compact form of
\r
1329 <see cref="F:MessagePack.MessagePackCode.MinFixMap"/>,
\r
1330 <see cref="F:MessagePack.MessagePackCode.Map16"/>, or
\r
1331 <see cref="F:MessagePack.MessagePackCode.Map32"/>
\r
1333 <param name="count">The number of key=value pairs that will be written in the map.</param>
\r
1335 <member name="M:MessagePack.MessagePackWriter.WriteMapHeader(System.UInt32)">
\r
1337 Write the length of the next map to be written in the most compact form of
\r
1338 <see cref="F:MessagePack.MessagePackCode.MinFixMap"/>,
\r
1339 <see cref="F:MessagePack.MessagePackCode.Map16"/>, or
\r
1340 <see cref="F:MessagePack.MessagePackCode.Map32"/>
\r
1342 <param name="count">The number of key=value pairs that will be written in the map.</param>
\r
1344 <member name="M:MessagePack.MessagePackWriter.Write(System.Byte)">
\r
1346 Writes a <see cref="T:System.Byte"/> value using a 1-byte code when possible, otherwise as <see cref="F:MessagePack.MessagePackCode.UInt8"/>.
\r
1348 <param name="value">The value.</param>
\r
1350 <member name="M:MessagePack.MessagePackWriter.WriteUInt8(System.Byte)">
\r
1352 Writes a <see cref="T:System.Byte"/> value using <see cref="F:MessagePack.MessagePackCode.UInt8"/>.
\r
1354 <param name="value">The value.</param>
\r
1356 <member name="M:MessagePack.MessagePackWriter.Write(System.SByte)">
\r
1358 Writes an 8-bit value using a 1-byte code when possible, otherwise as <see cref="F:MessagePack.MessagePackCode.Int8"/>.
\r
1360 <param name="value">The value.</param>
\r
1362 <member name="M:MessagePack.MessagePackWriter.WriteInt8(System.SByte)">
\r
1364 Writes an 8-bit value using <see cref="F:MessagePack.MessagePackCode.Int8"/>.
\r
1366 <param name="value">The value.</param>
\r
1368 <member name="M:MessagePack.MessagePackWriter.Write(System.UInt16)">
\r
1370 Writes a <see cref="T:System.UInt16"/> value using a 1-byte code when possible, otherwise as <see cref="F:MessagePack.MessagePackCode.UInt8"/> or <see cref="F:MessagePack.MessagePackCode.UInt16"/>.
\r
1372 <param name="value">The value.</param>
\r
1374 <member name="M:MessagePack.MessagePackWriter.WriteUInt16(System.UInt16)">
\r
1376 Writes a <see cref="T:System.UInt16"/> value using <see cref="F:MessagePack.MessagePackCode.UInt16"/>.
\r
1378 <param name="value">The value.</param>
\r
1380 <member name="M:MessagePack.MessagePackWriter.Write(System.Int16)">
\r
1382 Writes a <see cref="T:System.Int16"/> using a built-in 1-byte code when within specific MessagePack-supported ranges,
\r
1383 or the most compact of
\r
1384 <see cref="F:MessagePack.MessagePackCode.UInt8"/>,
\r
1385 <see cref="F:MessagePack.MessagePackCode.UInt16"/>,
\r
1386 <see cref="F:MessagePack.MessagePackCode.Int8"/>, or
\r
1387 <see cref="F:MessagePack.MessagePackCode.Int16"/>
\r
1389 <param name="value">The value to write.</param>
\r
1391 <member name="M:MessagePack.MessagePackWriter.WriteInt16(System.Int16)">
\r
1393 Writes a <see cref="T:System.Int16"/> using <see cref="F:MessagePack.MessagePackCode.Int16"/>.
\r
1395 <param name="value">The value to write.</param>
\r
1397 <member name="M:MessagePack.MessagePackWriter.Write(System.UInt32)">
\r
1399 Writes an <see cref="T:System.UInt32"/> using a built-in 1-byte code when within specific MessagePack-supported ranges,
\r
1400 or the most compact of
\r
1401 <see cref="F:MessagePack.MessagePackCode.UInt8"/>,
\r
1402 <see cref="F:MessagePack.MessagePackCode.UInt16"/>, or
\r
1403 <see cref="F:MessagePack.MessagePackCode.UInt32"/>
\r
1405 <param name="value">The value to write.</param>
\r
1407 <member name="M:MessagePack.MessagePackWriter.WriteUInt32(System.UInt32)">
\r
1409 Writes an <see cref="T:System.UInt32"/> using <see cref="F:MessagePack.MessagePackCode.UInt32"/>.
\r
1411 <param name="value">The value to write.</param>
\r
1413 <member name="M:MessagePack.MessagePackWriter.Write(System.Int32)">
\r
1415 Writes an <see cref="T:System.Int32"/> using a built-in 1-byte code when within specific MessagePack-supported ranges,
\r
1416 or the most compact of
\r
1417 <see cref="F:MessagePack.MessagePackCode.UInt8"/>,
\r
1418 <see cref="F:MessagePack.MessagePackCode.UInt16"/>,
\r
1419 <see cref="F:MessagePack.MessagePackCode.UInt32"/>,
\r
1420 <see cref="F:MessagePack.MessagePackCode.Int8"/>,
\r
1421 <see cref="F:MessagePack.MessagePackCode.Int16"/>,
\r
1422 <see cref="F:MessagePack.MessagePackCode.Int32"/>
\r
1424 <param name="value">The value to write.</param>
\r
1426 <member name="M:MessagePack.MessagePackWriter.WriteInt32(System.Int32)">
\r
1428 Writes an <see cref="T:System.Int32"/> using <see cref="F:MessagePack.MessagePackCode.Int32"/>.
\r
1430 <param name="value">The value to write.</param>
\r
1432 <member name="M:MessagePack.MessagePackWriter.Write(System.UInt64)">
\r
1434 Writes an <see cref="T:System.UInt64"/> using a built-in 1-byte code when within specific MessagePack-supported ranges,
\r
1435 or the most compact of
\r
1436 <see cref="F:MessagePack.MessagePackCode.UInt8"/>,
\r
1437 <see cref="F:MessagePack.MessagePackCode.UInt16"/>,
\r
1438 <see cref="F:MessagePack.MessagePackCode.UInt32"/>,
\r
1439 <see cref="F:MessagePack.MessagePackCode.Int8"/>,
\r
1440 <see cref="F:MessagePack.MessagePackCode.Int16"/>,
\r
1441 <see cref="F:MessagePack.MessagePackCode.Int32"/>
\r
1443 <param name="value">The value to write.</param>
\r
1445 <member name="M:MessagePack.MessagePackWriter.WriteUInt64(System.UInt64)">
\r
1447 Writes an <see cref="T:System.UInt64"/> using <see cref="F:MessagePack.MessagePackCode.Int32"/>.
\r
1449 <param name="value">The value to write.</param>
\r
1451 <member name="M:MessagePack.MessagePackWriter.Write(System.Int64)">
\r
1453 Writes an <see cref="T:System.Int64"/> using a built-in 1-byte code when within specific MessagePack-supported ranges,
\r
1454 or the most compact of
\r
1455 <see cref="F:MessagePack.MessagePackCode.UInt8"/>,
\r
1456 <see cref="F:MessagePack.MessagePackCode.UInt16"/>,
\r
1457 <see cref="F:MessagePack.MessagePackCode.UInt32"/>,
\r
1458 <see cref="F:MessagePack.MessagePackCode.UInt64"/>,
\r
1459 <see cref="F:MessagePack.MessagePackCode.Int8"/>,
\r
1460 <see cref="F:MessagePack.MessagePackCode.Int16"/>,
\r
1461 <see cref="F:MessagePack.MessagePackCode.Int32"/>,
\r
1462 <see cref="F:MessagePack.MessagePackCode.Int64"/>
\r
1464 <param name="value">The value to write.</param>
\r
1466 <member name="M:MessagePack.MessagePackWriter.WriteInt64(System.Int64)">
\r
1468 Writes an <see cref="T:System.Int64"/> using a built-in 1-byte code when within specific MessagePack-supported ranges,
\r
1469 or the most compact of
\r
1470 <see cref="F:MessagePack.MessagePackCode.UInt8"/>,
\r
1471 <see cref="F:MessagePack.MessagePackCode.UInt16"/>,
\r
1472 <see cref="F:MessagePack.MessagePackCode.UInt32"/>,
\r
1473 <see cref="F:MessagePack.MessagePackCode.UInt64"/>,
\r
1474 <see cref="F:MessagePack.MessagePackCode.Int8"/>,
\r
1475 <see cref="F:MessagePack.MessagePackCode.Int16"/>,
\r
1476 <see cref="F:MessagePack.MessagePackCode.Int32"/>,
\r
1477 <see cref="F:MessagePack.MessagePackCode.Int64"/>
\r
1479 <param name="value">The value to write.</param>
\r
1481 <member name="M:MessagePack.MessagePackWriter.Write(System.Boolean)">
\r
1483 Writes a <see cref="T:System.Boolean"/> value using either <see cref="F:MessagePack.MessagePackCode.True"/> or <see cref="F:MessagePack.MessagePackCode.False"/>.
\r
1485 <param name="value">The value.</param>
\r
1487 <member name="M:MessagePack.MessagePackWriter.Write(System.Char)">
\r
1489 Writes a <see cref="T:System.Char"/> value using a 1-byte code when possible, otherwise as <see cref="F:MessagePack.MessagePackCode.UInt8"/> or <see cref="F:MessagePack.MessagePackCode.UInt16"/>.
\r
1491 <param name="value">The value.</param>
\r
1493 <member name="M:MessagePack.MessagePackWriter.Write(System.Single)">
\r
1495 Writes a <see cref="F:MessagePack.MessagePackCode.Float32"/> value.
\r
1497 <param name="value">The value.</param>
\r
1499 <member name="M:MessagePack.MessagePackWriter.Write(System.Double)">
\r
1501 Writes a <see cref="F:MessagePack.MessagePackCode.Float64"/> value.
\r
1503 <param name="value">The value.</param>
\r
1505 <member name="M:MessagePack.MessagePackWriter.Write(System.DateTime)">
\r
1507 Writes a <see cref="T:System.DateTime"/> using the message code <see cref="F:MessagePack.ReservedMessagePackExtensionTypeCode.DateTime"/>.
\r
1509 <param name="dateTime">The value to write.</param>
\r
1511 <member name="M:MessagePack.MessagePackWriter.Write(System.ReadOnlySpan{System.Byte})">
\r
1513 Writes a span of bytes, prefixed with a length encoded as the smallest fitting from:
\r
1514 <see cref="F:MessagePack.MessagePackCode.Bin8"/>,
\r
1515 <see cref="F:MessagePack.MessagePackCode.Bin16"/>, or
\r
1516 <see cref="F:MessagePack.MessagePackCode.Bin32"/>,
\r
1518 <param name="src">The span of bytes to write.</param>
\r
1520 <member name="M:MessagePack.MessagePackWriter.Write(System.Buffers.ReadOnlySequence{System.Byte})">
\r
1522 Writes a sequence of bytes, prefixed with a length encoded as the smallest fitting from:
\r
1523 <see cref="F:MessagePack.MessagePackCode.Bin8"/>,
\r
1524 <see cref="F:MessagePack.MessagePackCode.Bin16"/>, or
\r
1525 <see cref="F:MessagePack.MessagePackCode.Bin32"/>,
\r
1527 <param name="src">The span of bytes to write.</param>
\r
1529 <member name="M:MessagePack.MessagePackWriter.WriteString(System.Buffers.ReadOnlySequence{System.Byte})">
\r
1531 Writes out an array of bytes that (may) represent a UTF-8 encoded string, prefixed with the length using one of these message codes:
\r
1532 <see cref="F:MessagePack.MessagePackCode.MinFixStr"/>,
\r
1533 <see cref="F:MessagePack.MessagePackCode.Str8"/>,
\r
1534 <see cref="F:MessagePack.MessagePackCode.Str16"/>,
\r
1535 <see cref="F:MessagePack.MessagePackCode.Str32"/>,
\r
1537 <param name="utf8stringBytes">The bytes to write.</param>
\r
1539 <member name="M:MessagePack.MessagePackWriter.WriteString(System.ReadOnlySpan{System.Byte})">
\r
1541 Writes out an array of bytes that (may) represent a UTF-8 encoded string, prefixed with the length using one of these message codes:
\r
1542 <see cref="F:MessagePack.MessagePackCode.MinFixStr"/>,
\r
1543 <see cref="F:MessagePack.MessagePackCode.Str8"/>,
\r
1544 <see cref="F:MessagePack.MessagePackCode.Str16"/>,
\r
1545 <see cref="F:MessagePack.MessagePackCode.Str32"/>,
\r
1547 <param name="utf8stringBytes">The bytes to write.</param>
\r
1549 <member name="M:MessagePack.MessagePackWriter.Write(System.String)">
\r
1551 Writes out a <see cref="T:System.String"/>, prefixed with the length using one of these message codes:
\r
1552 <see cref="F:MessagePack.MessagePackCode.MinFixStr"/>,
\r
1553 <see cref="F:MessagePack.MessagePackCode.Str8"/>,
\r
1554 <see cref="F:MessagePack.MessagePackCode.Str16"/>,
\r
1555 <see cref="F:MessagePack.MessagePackCode.Str32"/>,
\r
1557 <param name="value">The value to write. Must not be null.</param>
\r
1559 <member name="M:MessagePack.MessagePackWriter.Write(System.ReadOnlySpan{System.Char})">
\r
1561 Writes out a <see cref="T:System.String"/>, prefixed with the length using one of these message codes:
\r
1562 <see cref="F:MessagePack.MessagePackCode.MinFixStr"/>,
\r
1563 <see cref="F:MessagePack.MessagePackCode.Str8"/>,
\r
1564 <see cref="F:MessagePack.MessagePackCode.Str16"/>,
\r
1565 <see cref="F:MessagePack.MessagePackCode.Str32"/>,
\r
1567 <param name="value">The value to write.</param>
\r
1569 <member name="M:MessagePack.MessagePackWriter.WriteExtensionFormatHeader(MessagePack.ExtensionHeader)">
\r
1571 Writes the extension format header, using the smallest one of these codes:
\r
1572 <see cref="F:MessagePack.MessagePackCode.FixExt1"/>,
\r
1573 <see cref="F:MessagePack.MessagePackCode.FixExt2"/>,
\r
1574 <see cref="F:MessagePack.MessagePackCode.FixExt4"/>,
\r
1575 <see cref="F:MessagePack.MessagePackCode.FixExt8"/>,
\r
1576 <see cref="F:MessagePack.MessagePackCode.FixExt16"/>,
\r
1577 <see cref="F:MessagePack.MessagePackCode.Ext8"/>,
\r
1578 <see cref="F:MessagePack.MessagePackCode.Ext16"/>, or
\r
1579 <see cref="F:MessagePack.MessagePackCode.Ext32"/>.
\r
1581 <param name="extensionHeader">The extension header.</param>
\r
1583 <member name="M:MessagePack.MessagePackWriter.WriteExtensionFormat(MessagePack.ExtensionResult)">
\r
1585 Writes an extension format, using the smallest one of these codes:
\r
1586 <see cref="F:MessagePack.MessagePackCode.FixExt1"/>,
\r
1587 <see cref="F:MessagePack.MessagePackCode.FixExt2"/>,
\r
1588 <see cref="F:MessagePack.MessagePackCode.FixExt4"/>,
\r
1589 <see cref="F:MessagePack.MessagePackCode.FixExt8"/>,
\r
1590 <see cref="F:MessagePack.MessagePackCode.FixExt16"/>,
\r
1591 <see cref="F:MessagePack.MessagePackCode.Ext8"/>,
\r
1592 <see cref="F:MessagePack.MessagePackCode.Ext16"/>, or
\r
1593 <see cref="F:MessagePack.MessagePackCode.Ext32"/>.
\r
1595 <param name="extensionData">The extension data.</param>
\r
1597 <member name="M:MessagePack.MessagePackWriter.WriteBigEndian(System.UInt16)">
\r
1599 Writes a 16-bit integer in big endian format.
\r
1601 <param name="value">The integer.</param>
\r
1603 <member name="M:MessagePack.MessagePackWriter.WriteBigEndian(System.UInt32)">
\r
1605 Writes a 32-bit integer in big endian format.
\r
1607 <param name="value">The integer.</param>
\r
1609 <member name="M:MessagePack.MessagePackWriter.WriteBigEndian(System.UInt64)">
\r
1611 Writes a 64-bit integer in big endian format.
\r
1613 <param name="value">The integer.</param>
\r
1615 <member name="M:MessagePack.MessagePackWriter.WriteString_PrepareSpan(System.Int32,System.Int32@,System.Int32@)">
\r
1617 Estimates the length of the header required for a given string.
\r
1619 <param name="characterLength">The length of the string to be written, in characters.</param>
\r
1620 <param name="bufferSize">Receives the guaranteed length of the returned buffer.</param>
\r
1621 <param name="encodedBytesOffset">Receives the offset within the returned buffer to write the encoded string to.</param>
\r
1623 A reference to the first byte in the buffer.
\r
1626 <member name="M:MessagePack.MessagePackWriter.WriteString_PostEncoding(System.Byte*,System.Int32,System.Int32)">
\r
1628 Finalizes an encoding of a string.
\r
1630 <param name="pBuffer">A pointer obtained from a prior call to <see cref="M:MessagePack.MessagePackWriter.WriteString_PrepareSpan(System.Int32,System.Int32@,System.Int32@)"/>.</param>
\r
1631 <param name="estimatedOffset">The offset obtained from a prior call to <see cref="M:MessagePack.MessagePackWriter.WriteString_PrepareSpan(System.Int32,System.Int32@,System.Int32@)"/>.</param>
\r
1632 <param name="byteCount">The number of bytes used to actually encode the string.</param>
\r
1634 <member name="T:MessagePack.SequencePool">
\r
1636 A thread-safe, alloc-free reusable object pool.
\r
1639 <member name="M:MessagePack.SequencePool.#ctor(System.Int32)">
\r
1641 Initializes a new instance of the <see cref="T:MessagePack.SequencePool"/> class.
\r
1643 <param name="maxSize">The maximum size to allow the pool to grow.</param>
\r
1645 <member name="M:MessagePack.SequencePool.Rent">
\r
1647 Gets an instance of <see cref="T:Nerdbank.Streams.Sequence`1"/>
\r
1648 This is taken from the recycled pool if one is available; otherwise a new one is created.
\r
1650 <returns>The rental tracker that provides access to the object as well as a means to return it.</returns>
\r
1652 <member name="P:MessagePack.SequencePool.Rental.Value">
\r
1654 Gets the recyclable object.
\r
1657 <member name="M:MessagePack.SequencePool.Rental.Dispose">
\r
1659 Returns the recyclable object to the pool.
\r
1662 The instance is cleaned first, if a clean delegate was provided.
\r
1663 It is dropped instead of being returned to the pool if the pool is already at its maximum size.
\r
1666 <member name="F:System.Buffers.SequenceReader`1._usingSequence">
\r
1668 A value indicating whether we're using <see cref="F:System.Buffers.SequenceReader`1._sequence"/> (as opposed to <see cref="F:System.Buffers.SequenceReader`1._memory"/>.
\r
1671 <member name="F:System.Buffers.SequenceReader`1._sequence">
\r
1673 Backing for the entire sequence when we're not using <see cref="F:System.Buffers.SequenceReader`1._memory"/>.
\r
1676 <member name="F:System.Buffers.SequenceReader`1._currentPosition">
\r
1678 The position at the start of the <see cref="P:System.Buffers.SequenceReader`1.CurrentSpan"/>.
\r
1681 <member name="F:System.Buffers.SequenceReader`1._nextPosition">
\r
1683 The position at the end of the <see cref="P:System.Buffers.SequenceReader`1.CurrentSpan"/>.
\r
1686 <member name="F:System.Buffers.SequenceReader`1._memory">
\r
1688 Backing for the entire sequence when we're not using <see cref="F:System.Buffers.SequenceReader`1._sequence"/>.
\r
1691 <member name="F:System.Buffers.SequenceReader`1._moreData">
\r
1693 A value indicating whether there is unread data remaining.
\r
1696 <member name="F:System.Buffers.SequenceReader`1._length">
\r
1698 The total number of elements in the sequence.
\r
1701 <member name="M:System.Buffers.SequenceReader`1.#ctor(System.Buffers.ReadOnlySequence{`0})">
\r
1703 Initializes a new instance of the <see cref="T:System.Buffers.SequenceReader`1"/> struct
\r
1704 over the given <see cref="T:System.Buffers.ReadOnlySequence`1"/>.
\r
1707 <member name="M:System.Buffers.SequenceReader`1.#ctor(System.ReadOnlyMemory{`0})">
\r
1709 Initializes a new instance of the <see cref="T:System.Buffers.SequenceReader`1"/> struct
\r
1710 over the given <see cref="T:System.ReadOnlyMemory`1"/>.
\r
1713 <member name="P:System.Buffers.SequenceReader`1.End">
\r
1715 True when there is no more data in the <see cref="P:System.Buffers.SequenceReader`1.Sequence"/>.
\r
1718 <member name="P:System.Buffers.SequenceReader`1.Sequence">
\r
1720 The underlying <see cref="T:System.Buffers.ReadOnlySequence`1"/> for the reader.
\r
1723 <member name="P:System.Buffers.SequenceReader`1.Position">
\r
1725 The current position in the <see cref="P:System.Buffers.SequenceReader`1.Sequence"/>.
\r
1728 <member name="P:System.Buffers.SequenceReader`1.CurrentSpan">
\r
1730 The current segment in the <see cref="P:System.Buffers.SequenceReader`1.Sequence"/> as a span.
\r
1733 <member name="P:System.Buffers.SequenceReader`1.CurrentSpanIndex">
\r
1735 The index in the <see cref="P:System.Buffers.SequenceReader`1.CurrentSpan"/>.
\r
1738 <member name="P:System.Buffers.SequenceReader`1.UnreadSpan">
\r
1740 The unread portion of the <see cref="P:System.Buffers.SequenceReader`1.CurrentSpan"/>.
\r
1743 <member name="P:System.Buffers.SequenceReader`1.Consumed">
\r
1745 The total number of <typeparamref name="T"/>'s processed by the reader.
\r
1748 <member name="P:System.Buffers.SequenceReader`1.Remaining">
\r
1750 Remaining <typeparamref name="T"/>'s in the reader's <see cref="P:System.Buffers.SequenceReader`1.Sequence"/>.
\r
1753 <member name="P:System.Buffers.SequenceReader`1.Length">
\r
1755 Count of <typeparamref name="T"/> in the reader's <see cref="P:System.Buffers.SequenceReader`1.Sequence"/>.
\r
1758 <member name="M:System.Buffers.SequenceReader`1.TryPeek(`0@)">
\r
1760 Peeks at the next value without advancing the reader.
\r
1762 <param name="value">The next value or default if at the end.</param>
\r
1763 <returns>False if at the end of the reader.</returns>
\r
1765 <member name="M:System.Buffers.SequenceReader`1.TryRead(`0@)">
\r
1767 Read the next value and advance the reader.
\r
1769 <param name="value">The next value or default if at the end.</param>
\r
1770 <returns>False if at the end of the reader.</returns>
\r
1772 <member name="M:System.Buffers.SequenceReader`1.Rewind(System.Int64)">
\r
1774 Move the reader back the specified number of items.
\r
1777 <member name="M:System.Buffers.SequenceReader`1.GetNextSpan">
\r
1779 Get the next segment with available data, if any.
\r
1782 <member name="M:System.Buffers.SequenceReader`1.Advance(System.Int64)">
\r
1784 Move the reader ahead the specified number of items.
\r
1787 <member name="M:System.Buffers.SequenceReader`1.AdvanceCurrentSpan(System.Int64)">
\r
1789 Unchecked helper to avoid unnecessary checks where you know count is valid.
\r
1792 <member name="M:System.Buffers.SequenceReader`1.AdvanceWithinSpan(System.Int64)">
\r
1794 Only call this helper if you know that you are advancing in the current span
\r
1795 with valid count and there is no need to fetch the next one.
\r
1798 <member name="M:System.Buffers.SequenceReader`1.TryCopyTo(System.Span{`0})">
\r
1800 Copies data from the current <see cref="P:System.Buffers.SequenceReader`1.Position"/> to the given <paramref name="destination"/> span.
\r
1802 <param name="destination">Destination to copy to.</param>
\r
1803 <returns>True if there is enough data to copy to the <paramref name="destination"/>.</returns>
\r
1805 <member name="M:System.Buffers.SequenceReaderExtensions.TryRead``1(System.Buffers.SequenceReader{System.Byte}@,``0@)">
\r
1807 Try to read the given type out of the buffer if possible. Warning: this is dangerous to use with arbitrary
\r
1808 structs- see remarks for full details.
\r
1811 IMPORTANT: The read is a straight copy of bits. If a struct depends on specific state of its members to
\r
1812 behave correctly this can lead to exceptions, etc. If reading endian specific integers, use the explicit
\r
1813 overloads such as <see cref="M:System.Buffers.SequenceReaderExtensions.TryReadLittleEndian(System.Buffers.SequenceReader{System.Byte}@,System.Int16@)"/>
\r
1816 True if successful. <paramref name="value"/> will be default if failed (due to lack of space).
\r
1819 <member name="M:System.Buffers.SequenceReaderExtensions.TryRead(System.Buffers.SequenceReader{System.Byte}@,System.SByte@)">
\r
1821 Reads an <see cref="T:System.SByte"/> from the next position in the sequence.
\r
1823 <param name="reader">The reader to read from.</param>
\r
1824 <param name="value">Receives the value read.</param>
\r
1825 <returns><c>true</c> if there was another byte in the sequence; <c>false</c> otherwise.</returns>
\r
1827 <member name="M:System.Buffers.SequenceReaderExtensions.TryReadLittleEndian(System.Buffers.SequenceReader{System.Byte}@,System.Int16@)">
\r
1829 Reads an <see cref="T:System.Int16"/> as little endian.
\r
1831 <returns>False if there wasn't enough data for an <see cref="T:System.Int16"/>.</returns>
\r
1833 <member name="M:System.Buffers.SequenceReaderExtensions.TryReadBigEndian(System.Buffers.SequenceReader{System.Byte}@,System.Int16@)">
\r
1835 Reads an <see cref="T:System.Int16"/> as big endian.
\r
1837 <returns>False if there wasn't enough data for an <see cref="T:System.Int16"/>.</returns>
\r
1839 <member name="M:System.Buffers.SequenceReaderExtensions.TryReadBigEndian(System.Buffers.SequenceReader{System.Byte}@,System.UInt16@)">
\r
1841 Reads an <see cref="T:System.UInt16"/> as big endian.
\r
1843 <returns>False if there wasn't enough data for an <see cref="T:System.UInt16"/>.</returns>
\r
1845 <member name="M:System.Buffers.SequenceReaderExtensions.TryReadLittleEndian(System.Buffers.SequenceReader{System.Byte}@,System.Int32@)">
\r
1847 Reads an <see cref="T:System.Int32"/> as little endian.
\r
1849 <returns>False if there wasn't enough data for an <see cref="T:System.Int32"/>.</returns>
\r
1851 <member name="M:System.Buffers.SequenceReaderExtensions.TryReadBigEndian(System.Buffers.SequenceReader{System.Byte}@,System.Int32@)">
\r
1853 Reads an <see cref="T:System.Int32"/> as big endian.
\r
1855 <returns>False if there wasn't enough data for an <see cref="T:System.Int32"/>.</returns>
\r
1857 <member name="M:System.Buffers.SequenceReaderExtensions.TryReadBigEndian(System.Buffers.SequenceReader{System.Byte}@,System.UInt32@)">
\r
1859 Reads an <see cref="T:System.UInt32"/> as big endian.
\r
1861 <returns>False if there wasn't enough data for an <see cref="T:System.UInt32"/>.</returns>
\r
1863 <member name="M:System.Buffers.SequenceReaderExtensions.TryReadLittleEndian(System.Buffers.SequenceReader{System.Byte}@,System.Int64@)">
\r
1865 Reads an <see cref="T:System.Int64"/> as little endian.
\r
1867 <returns>False if there wasn't enough data for an <see cref="T:System.Int64"/>.</returns>
\r
1869 <member name="M:System.Buffers.SequenceReaderExtensions.TryReadBigEndian(System.Buffers.SequenceReader{System.Byte}@,System.Int64@)">
\r
1871 Reads an <see cref="T:System.Int64"/> as big endian.
\r
1873 <returns>False if there wasn't enough data for an <see cref="T:System.Int64"/>.</returns>
\r
1875 <member name="M:System.Buffers.SequenceReaderExtensions.TryReadBigEndian(System.Buffers.SequenceReader{System.Byte}@,System.UInt64@)">
\r
1877 Reads an <see cref="T:System.UInt64"/> as big endian.
\r
1879 <returns>False if there wasn't enough data for an <see cref="T:System.UInt64"/>.</returns>
\r
projects / platform / core / dotnet / build-tools.git / blob