update 20250326
This commit is contained in:
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -258,7 +258,7 @@
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
@@ -392,7 +392,7 @@
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
@@ -401,7 +401,7 @@
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
API_NetFramework/bin/System.IO.Pipelines.dll
Normal file
BIN
API_NetFramework/bin/System.IO.Pipelines.dll
Normal file
Binary file not shown.
391
API_NetFramework/bin/System.IO.Pipelines.xml
Normal file
391
API_NetFramework/bin/System.IO.Pipelines.xml
Normal file
@@ -0,0 +1,391 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>System.IO.Pipelines</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.IO.Pipelines.FlushResult">
|
||||
<summary>Result returned by <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> call.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.FlushResult.#ctor(System.Boolean,System.Boolean)">
|
||||
<summary>Initializes a new instance of <see cref="T:System.IO.Pipelines.FlushResult" /> struct setting the <see cref="P:System.IO.Pipelines.FlushResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.FlushResult.IsCompleted" /> flags.</summary>
|
||||
<param name="isCanceled">
|
||||
<see langword="true" /> to indicate the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.FlushResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />; otherwise, <see langword="false" />.</param>
|
||||
<param name="isCompleted">
|
||||
<see langword="true" /> to indicate the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</param>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.FlushResult.IsCanceled">
|
||||
<summary>Gets a value that indicates whether the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.FlushResult.IsCompleted">
|
||||
<summary>Gets a value that indicates the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.IDuplexPipe">
|
||||
<summary>Defines a class that provides a duplex pipe from which data can be read from and written to.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.IDuplexPipe.Input">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> half of the duplex pipe.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.IDuplexPipe.Output">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> half of the duplex pipe.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.Pipe">
|
||||
<summary>The default <see cref="T:System.IO.Pipelines.PipeWriter" /> and <see cref="T:System.IO.Pipelines.PipeReader" /> implementation.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.#ctor">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.Pipe" /> class using <see cref="P:System.IO.Pipelines.PipeOptions.Default" /> as options.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.#ctor(System.IO.Pipelines.PipeOptions)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.Pipe" /> class with the specified options.</summary>
|
||||
<param name="options">The set of options for this pipe.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.Reset">
|
||||
<summary>Resets the pipe.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.Pipe.Reader">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> for this pipe.</summary>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> instance for this pipe.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.Pipe.Writer">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> for this pipe.</summary>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeWriter" /> instance for this pipe.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeOptions">
|
||||
<summary>Represents a set of <see cref="T:System.IO.Pipelines.Pipe" /> options.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.IO.Pipelines.PipeScheduler,System.IO.Pipelines.PipeScheduler,System.Int64,System.Int64,System.Int32,System.Boolean)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeOptions" /> class with the specified parameters.</summary>
|
||||
<param name="pool">The pool of memory blocks to be used for buffer management.</param>
|
||||
<param name="readerScheduler">The <see cref="T:System.IO.Pipelines.PipeScheduler" /> to be used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</param>
|
||||
<param name="writerScheduler">The <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</param>
|
||||
<param name="pauseWriterThreshold">The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> before <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking. A value of zero prevents <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> from ever blocking, effectively making the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> unlimited.</param>
|
||||
<param name="resumeWriterThreshold">The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</param>
|
||||
<param name="minimumSegmentSize">The minimum size of the segment requested from <paramref name="pool" />.</param>
|
||||
<param name="useSynchronizationContext">
|
||||
<see langword="true" /> if asynchronous continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on; <see langword="false" /> otherwise. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</param>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.Default">
|
||||
<summary>Gets the default instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeOptions" /> object initialized with default parameters.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.MinimumSegmentSize">
|
||||
<summary>Gets the minimum size of the segment requested from the <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</summary>
|
||||
<returns>The minimum size of the segment requested from the <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.PauseWriterThreshold">
|
||||
<summary>Gets the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking. A value of zero prevents <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> from ever blocking, effectively making the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> unlimited.</summary>
|
||||
<returns>The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.Pool">
|
||||
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> object used for buffer management.</summary>
|
||||
<returns>A pool of memory blocks used for buffer management.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.ReaderScheduler">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</summary>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> that is used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.ResumeWriterThreshold">
|
||||
<summary>Gets the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</summary>
|
||||
<returns>The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.UseSynchronizationContext">
|
||||
<summary>Gets a value that determines if asynchronous callbacks and continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if asynchronous callbacks and continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.WriterScheduler">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</summary>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> object used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeReader">
|
||||
<summary>Defines a class that provides access to a read side of pipe.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.#ctor">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeReader" /> class.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition,System.SequencePosition)">
|
||||
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed, read and examined.</summary>
|
||||
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
|
||||
<param name="examined">Marks the extent of the data that has been read and examined.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition)">
|
||||
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed.</summary>
|
||||
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.AsStream(System.Boolean)">
|
||||
<summary>Returns a <see cref="T:System.IO.Stream" /> representation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
|
||||
<returns>A stream that represents the <see cref="T:System.IO.Pipelines.PipeReader" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CancelPendingRead">
|
||||
<summary>Cancels the pending <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation without causing it to throw and without completing the <see cref="T:System.IO.Pipelines.PipeReader" />. If there is no pending operation, this cancels the next operation.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.Complete(System.Exception)">
|
||||
<summary>Signals to the producer that the consumer is done reading.</summary>
|
||||
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CompleteAsync(System.Exception)">
|
||||
<summary>Marks the current pipe reader instance as being complete, meaning no more data will be read from it.</summary>
|
||||
<param name="exception">An optional exception that indicates the failure that caused the reader to complete.</param>
|
||||
<returns>A value task that represents the asynchronous complete operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a specified cancellation token.</summary>
|
||||
<param name="destination">The pipe writer to which the contents of the current stream will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified stream, using a specified cancellation token.</summary>
|
||||
<param name="destination">The stream to which the contents of the current stream will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.Create(System.Buffers.ReadOnlySequence{System.Byte})">
|
||||
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeReader" /> wrapping the specified <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
|
||||
<param name="sequence">The sequence to wrap.</param>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> that wraps the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeReaderOptions)">
|
||||
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeReader" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
|
||||
<param name="stream">The stream that the pipe reader will wrap.</param>
|
||||
<param name="readerOptions">The options to configure the pipe reader.</param>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.OnWriterCompleted(System.Action{System.Exception,System.Object},System.Object)">
|
||||
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeWriter" /> side of the pipe is completed.</summary>
|
||||
<param name="callback">The callback to register.</param>
|
||||
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.ReadAtLeastAsync(System.Int32,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="minimumSize">The minimum length that needs to be buffered in order for the call to return.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.ReadAtLeastAsyncCore(System.Int32,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="minimumSize">The minimum length that needs to be buffered in order for the call to return.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.TryRead(System.IO.Pipelines.ReadResult@)">
|
||||
<summary>Attempts to synchronously read data the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="result">When this method returns <see langword="true" />, this value is set to a <see cref="T:System.IO.Pipelines.ReadResult" /> instance that represents the result of the read call; otherwise, this value is set to <see langword="default" />.</param>
|
||||
<returns>
|
||||
<see langword="true" /> if data was available, or if the call was canceled or the writer was completed; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeScheduler">
|
||||
<summary>Abstraction for running <see cref="T:System.IO.Pipelines.PipeReader" /> and <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and continuations.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeScheduler.#ctor">
|
||||
<summary>Initializes new a <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeScheduler.Schedule(System.Action{System.Object},System.Object)">
|
||||
<summary>Requests <paramref name="action" /> to be run on scheduler with <paramref name="state" /> being passed in.</summary>
|
||||
<param name="action">The single-parameter action delegate to schedule.</param>
|
||||
<param name="state">The parameter to pass to the <paramref name="action" /> delegate.</param>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeScheduler.Inline">
|
||||
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that runs callbacks inline.</summary>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance that runs callbacks inline.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeScheduler.ThreadPool">
|
||||
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that queues callbacks to the thread pool.</summary>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance that queues callbacks to the thread pool.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeWriter">
|
||||
<summary>Defines a class that provides a pipeline to which data can be written.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.#ctor">
|
||||
<summary>Initializes a new instance of the class.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)">
|
||||
<summary>Notifies the <see cref="T:System.IO.Pipelines.PipeWriter" /> that <paramref name="bytes" /> bytes were written to the output <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />. You must call <see cref="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)" /> or <see cref="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)" /> again and use the returned buffer to continue writing more data after calling <see cref="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)" />; you cannot write to a previously acquired buffer.</summary>
|
||||
<param name="bytes">The number of bytes written to the <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.AsStream(System.Boolean)">
|
||||
<summary>Returns a <see cref="T:System.IO.Stream" /> representation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
|
||||
<returns>A stream that represents the <see cref="T:System.IO.Pipelines.PipeWriter" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush">
|
||||
<summary>Cancels the pending <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> or <see cref="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)" /> operation without causing the operation to throw and without completing the <see cref="T:System.IO.Pipelines.PipeWriter" />. If there is no pending operation, this cancels the next operation.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.Complete(System.Exception)">
|
||||
<summary>Marks the <see cref="T:System.IO.Pipelines.PipeWriter" /> as being complete, meaning no more items will be written to it.</summary>
|
||||
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.CompleteAsync(System.Exception)">
|
||||
<summary>Marks the current pipe writer instance as being complete, meaning no more data will be written to it.</summary>
|
||||
<param name="exception">An optional exception that indicates the failure that caused the pipeline to complete.</param>
|
||||
<returns>A value task that represents the asynchronous complete operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.CopyFromAsync(System.IO.Stream,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the specified stream and writes them to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
<param name="source">The stream from which the contents will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeWriterOptions)">
|
||||
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeWriter" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
|
||||
<param name="stream">The stream that the pipe writer will wrap.</param>
|
||||
<param name="writerOptions">The options to configure the pipe writer.</param>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeWriter" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)">
|
||||
<summary>Makes bytes written available to <see cref="T:System.IO.Pipelines.PipeReader" /> and runs <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> continuation.</summary>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A task that represents and wraps the asynchronous flush operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)">
|
||||
<summary>Returns a <see cref="T:System.Memory`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
|
||||
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Memory`1" />. If 0, a non-empty memory buffer of arbitrary size is returned.</param>
|
||||
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
|
||||
<returns>A memory buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)">
|
||||
<summary>Returns a <see cref="T:System.Span`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
|
||||
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Span`1" />. If 0, a non-empty buffer of arbitrary size is returned.</param>
|
||||
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
|
||||
<returns>A buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.OnReaderCompleted(System.Action{System.Exception,System.Object},System.Object)">
|
||||
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeReader" /> side of the pipe is completed.</summary>
|
||||
<param name="callback">The callback to register.</param>
|
||||
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
|
||||
<summary>Writes the specified byte memory range to the pipe and makes data accessible to the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="source">The read-only byte memory region to write.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A task that represents the asynchronous write operation, and wraps the flush asynchronous operation.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeWriter.CanGetUnflushedBytes">
|
||||
<summary>Gets a value that indicates whether the current <see cref="T:System.IO.Pipelines.PipeWriter" /> supports reporting the count of unflushed bytes.</summary>
|
||||
<returns>
|
||||
<see langword="true" />If a class derived from <see cref="T:System.IO.Pipelines.PipeWriter" /> does not support getting the unflushed bytes, calls to <see cref="P:System.IO.Pipelines.PipeWriter.UnflushedBytes" /> throw <see cref="T:System.NotImplementedException" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeWriter.UnflushedBytes">
|
||||
<summary>When overridden in a derived class, gets the count of unflushed bytes within the current writer.</summary>
|
||||
<exception cref="T:System.NotImplementedException">The <see cref="T:System.IO.Pipelines.PipeWriter" /> does not support getting the unflushed byte count.</exception>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.ReadResult">
|
||||
<summary>Represents the result of a <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.ReadResult.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Boolean,System.Boolean)">
|
||||
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.ReadResult" /> setting <see cref="P:System.IO.Pipelines.ReadResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.ReadResult.IsCompleted" /> flags.</summary>
|
||||
<param name="buffer">The read-only sequence containing the bytes of data that were read in the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</param>
|
||||
<param name="isCanceled">A flag that indicates if the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.ReadResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />.</param>
|
||||
<param name="isCompleted">A flag that indicates whether the end of the data stream has been reached.</param>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.Buffer">
|
||||
<summary>Gets the <see cref="T:System.Buffers.ReadOnlySequence`1" /> that was read.</summary>
|
||||
<returns>A read-only sequence containing the bytes of data that were read in the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.IsCanceled">
|
||||
<summary>Gets a value that indicates whether the current <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.ReadResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.IsCompleted">
|
||||
<summary>Gets a value that indicates whether the end of the data stream has been reached.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if the end of the data stream has been reached; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.StreamPipeExtensions">
|
||||
<summary>Provides extension methods for <see cref="T:System.IO.Stream" /> that support read and write operations directly into pipes.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.StreamPipeExtensions.CopyToAsync(System.IO.Stream,System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Stream" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a cancellation token.</summary>
|
||||
<param name="source">The stream from which the contents of the current stream will be copied.</param>
|
||||
<param name="destination">The writer to which the contents of the source stream will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.StreamPipeReaderOptions">
|
||||
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.StreamPipeReaderOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Int32,System.Boolean,System.Boolean)">
|
||||
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeReaderOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
|
||||
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
|
||||
<param name="bufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
|
||||
<param name="minimumReadSize">The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.</param>
|
||||
<param name="leaveOpen">
|
||||
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
|
||||
<param name="useZeroByteReads">
|
||||
<see langword="true" /> if reads with an empty buffer should be issued to the underlying stream before allocating memory; otherwise, <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.StreamPipeReaderOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Int32,System.Boolean)">
|
||||
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeReaderOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
|
||||
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
|
||||
<param name="bufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
|
||||
<param name="minimumReadSize">The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.</param>
|
||||
<param name="leaveOpen">
|
||||
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.BufferSize">
|
||||
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool" />.</summary>
|
||||
<returns>The buffer size.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.LeaveOpen">
|
||||
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.MinimumReadSize">
|
||||
<summary>Gets the threshold of remaining bytes in the buffer before a new buffer is allocated.</summary>
|
||||
<returns>The minimum read size.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool">
|
||||
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
|
||||
<returns>A memory pool instance.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.UseZeroByteReads">
|
||||
<summary>Gets the value that indicates if reads with an empty buffer should be issued to the underlying stream, in order to wait for data to arrive before allocating memory.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if reads with an empty buffer should be issued to the underlying stream before allocating memory; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.StreamPipeWriterOptions">
|
||||
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.StreamPipeWriterOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Boolean)">
|
||||
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeWriterOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
|
||||
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
|
||||
<param name="minimumBufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
|
||||
<param name="leaveOpen">
|
||||
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.LeaveOpen">
|
||||
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.MinimumBufferSize">
|
||||
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool" />.</summary>
|
||||
<returns>An integer representing the minimum buffer size.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool">
|
||||
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
|
||||
<returns>A memory pool instance.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -1,4 +1,5 @@
|
||||
<?xml version="1.0" encoding="utf-8"?><doc>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>System.Text.Encodings.Web</name>
|
||||
</assembly>
|
||||
@@ -7,110 +8,154 @@
|
||||
<summary>Represents an HTML character encoding.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.HtmlEncoder.#ctor">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder"></see> class.</summary>
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.HtmlEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
|
||||
<summary>Creates a new instance of the HtmlEncoder class with the specified settings.</summary>
|
||||
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.HtmlEncoder"></see> instance encodes, primarily which characters to encode.</param>
|
||||
<returns>A new instance of the <see cref="System.Text.Encodings.Web.HtmlEncoder"></see> class.</returns>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="settings">settings</paramref> is null.</exception>
|
||||
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> instance encodes, primarily which characters to encode.</param>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="settings" /> is <see langword="null" />.</exception>
|
||||
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.HtmlEncoder.Create(System.Text.Unicode.UnicodeRange[])">
|
||||
<summary>Creates a new instance of the HtmlEncoder class that specifies characters the encoder is allowed to not encode.</summary>
|
||||
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
|
||||
<returns>A new instance of the <see cref="System.Text.Encodings.Web.HtmlEncoder"></see> class.</returns>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="allowedRanges">allowedRanges</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
|
||||
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Encodings.Web.HtmlEncoder.Default">
|
||||
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder"></see> class.</summary>
|
||||
<returns>A built-in instance of the <see cref="System.Text.Encodings.Web.HtmlEncoder"></see> class.</returns>
|
||||
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</summary>
|
||||
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
|
||||
</member>
|
||||
<member name="T:System.Text.Encodings.Web.JavaScriptEncoder">
|
||||
<summary>Represents a JavaScript character encoding.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.#ctor">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</summary>
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
|
||||
<summary>Creates a new instance of JavaScriptEncoder class with the specified settings.</summary>
|
||||
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder"></see> instance encodes, primarily which characters to encode.</param>
|
||||
<returns>A new instance of the <see cref="System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</returns>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="settings">settings</paramref> is null.</exception>
|
||||
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> instance encodes, primarily which characters to encode.</param>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="settings" /> is <see langword="null" />.</exception>
|
||||
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.Create(System.Text.Unicode.UnicodeRange[])">
|
||||
<summary>Creates a new instance of the JavaScriptEncoder class that specifies characters the encoder is allowed to not encode.</summary>
|
||||
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
|
||||
<returns>A new instance of the <see cref="System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</returns>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="allowedRanges">allowedRanges</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
|
||||
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Encodings.Web.JavaScriptEncoder.Default">
|
||||
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</summary>
|
||||
<returns>A built-in instance of the <see cref="System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</returns>
|
||||
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</summary>
|
||||
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping">
|
||||
<summary>Gets a built-in JavaScript encoder instance that is less strict about what is encoded.</summary>
|
||||
<returns>A JavaScript encoder instance.</returns>
|
||||
</member>
|
||||
<member name="T:System.Text.Encodings.Web.TextEncoder">
|
||||
<summary>The base class of web encoders.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoder.#ctor">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.TextEncoder"></see> class.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.String)">
|
||||
<summary>Encodes the supplied string and returns the encoded text as a new string.</summary>
|
||||
<param name="value">The string to encode.</param>
|
||||
<returns>The encoded string.</returns>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="value">value</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentException">The <see cref="System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)"></see> method failed. The encoder does not implement <see cref="System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter"></see> correctly.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.String)">
|
||||
<summary>Encodes the specified string to a <see cref="T:System.IO.TextWriter"></see> object.</summary>
|
||||
<param name="output">The stream to which to write the encoded text.</param>
|
||||
<param name="value">The string to encode.</param>
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.TextEncoder" /> class.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.Char[],System.Int32,System.Int32)">
|
||||
<summary>Encodes characters from an array and writes them to a <see cref="T:System.IO.TextWriter"></see> object.</summary>
|
||||
<summary>Encodes characters from an array and writes them to a <see cref="T:System.IO.TextWriter" /> object.</summary>
|
||||
<param name="output">The stream to which to write the encoded text.</param>
|
||||
<param name="value">The array of characters to encode.</param>
|
||||
<param name="startIndex">The array index of the first character to encode.</param>
|
||||
<param name="characterCount">The number of characters in the array to encode.</param>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="output">output</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentException">The <see cref="System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)"></see> method failed. The encoder does not implement <see cref="System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter"></see> correctly.</exception>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="value">value</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex">startIndex</paramref> is out of range.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="characterCount">characterCount</paramref> is out of range.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="output" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="value" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="startIndex" /> is out of range.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="characterCount" /> is out of range.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.String,System.Int32,System.Int32)">
|
||||
<summary>Encodes a substring and writes it to a <see cref="T:System.IO.TextWriter"></see> object.</summary>
|
||||
<summary>Encodes a substring and writes it to a <see cref="T:System.IO.TextWriter" /> object.</summary>
|
||||
<param name="output">The stream to which to write the encoded text.</param>
|
||||
<param name="value">The string whose substring is to be encoded.</param>
|
||||
<param name="startIndex">The index where the substring starts.</param>
|
||||
<param name="characterCount">The number of characters in the substring.</param>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="output">output</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentException">The <see cref="System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)"></see> method failed. The encoder does not implement <see cref="System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter"></see> correctly.</exception>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="value">value</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex">startIndex</paramref> is out of range.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="characterCount">characterCount</paramref> is out of range.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="output" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="value" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="startIndex" /> is out of range.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="characterCount" /> is out of range.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.String)">
|
||||
<summary>Encodes the specified string to a <see cref="T:System.IO.TextWriter" /> object.</summary>
|
||||
<param name="output">The stream to which to write the encoded text.</param>
|
||||
<param name="value">The string to encode.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.ReadOnlySpan{System.Char},System.Span{System.Char},System.Int32@,System.Int32@,System.Boolean)">
|
||||
<summary>Encodes the supplied characters.</summary>
|
||||
<param name="source">A source buffer containing the characters to encode.</param>
|
||||
<param name="destination">The destination buffer to which the encoded form of <paramref name="source" /> will be written.</param>
|
||||
<param name="charsConsumed">The number of characters consumed from the <paramref name="source" /> buffer.</param>
|
||||
<param name="charsWritten">The number of characters written to the <paramref name="destination" /> buffer.</param>
|
||||
<param name="isFinalBlock">
|
||||
<see langword="true" /> to indicate there is no further source data that needs to be encoded; otherwise, <see langword="false" />.</param>
|
||||
<returns>An enumeration value that describes the result of the encoding operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.String)">
|
||||
<summary>Encodes the supplied string and returns the encoded text as a new string.</summary>
|
||||
<param name="value">The string to encode.</param>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="value" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
|
||||
<returns>The encoded string.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoder.EncodeUtf8(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32@,System.Boolean)">
|
||||
<summary>Encodes the supplied UTF-8 text.</summary>
|
||||
<param name="utf8Source">A source buffer containing the UTF-8 text to encode.</param>
|
||||
<param name="utf8Destination">The destination buffer to which the encoded form of <paramref name="utf8Source" /> will be written.</param>
|
||||
<param name="bytesConsumed">The number of bytes consumed from the <paramref name="utf8Source" /> buffer.</param>
|
||||
<param name="bytesWritten">The number of bytes written to the <paramref name="utf8Destination" /> buffer.</param>
|
||||
<param name="isFinalBlock">
|
||||
<see langword="true" /> to indicate there is no further source data that needs to be encoded; otherwise, <see langword="false" />.</param>
|
||||
<returns>A status code that describes the result of the encoding operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoder.FindFirstCharacterToEncode(System.Char*,System.Int32)">
|
||||
<summary>Finds the index of the first character to encode.</summary>
|
||||
<param name="text">The text buffer to search.</param>
|
||||
<param name="textLength">The number of characters in <paramref name="text">text</paramref>.</param>
|
||||
<param name="textLength">The number of characters in <paramref name="text" />.</param>
|
||||
<returns>The index of the first character to encode.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter">
|
||||
<summary>Gets the maximum number of characters that this encoder can generate for each input code point.</summary>
|
||||
<returns>The maximum number of characters.</returns>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoder.FindFirstCharacterToEncodeUtf8(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Finds the first element in a UTF-8 text input buffer that would be escaped by the current encoder instance.</summary>
|
||||
<param name="utf8Text">The UTF-8 text input buffer to search.</param>
|
||||
<returns>The index of the first element in <paramref name="utf8Text" /> that would be escaped by the current encoder instance, or -1 if no data in <paramref name="utf8Text" /> requires escaping.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)">
|
||||
<summary>Encodes a Unicode scalar value and writes it to a buffer.</summary>
|
||||
<param name="unicodeScalar">A Unicode scalar value.</param>
|
||||
<param name="buffer">A pointer to the buffer to which to write the encoded text.</param>
|
||||
<param name="bufferLength">The length of the destination <paramref name="buffer">buffer</paramref> in characters.</param>
|
||||
<param name="numberOfCharactersWritten">When the method returns, indicates the number of characters written to the <paramref name="buffer">buffer</paramref>.</param>
|
||||
<returns>false if <paramref name="bufferLength">bufferLength</paramref> is too small to fit the encoded text; otherwise, returns true.</returns>
|
||||
<param name="bufferLength">The length of the destination <paramref name="buffer" /> in characters.</param>
|
||||
<param name="numberOfCharactersWritten">When the method returns, indicates the number of characters written to the <paramref name="buffer" />.</param>
|
||||
<returns>
|
||||
<see langword="false" /> if <paramref name="bufferLength" /> is too small to fit the encoded text; otherwise, returns <see langword="true" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoder.WillEncode(System.Int32)">
|
||||
<summary>Determines if a given Unicode scalar value will be encoded.</summary>
|
||||
<param name="unicodeScalar">A Unicode scalar value.</param>
|
||||
<returns>true if the <paramref name="unicodeScalar">unicodeScalar</paramref> value will be encoded by this encoder; otherwise, returns false.</returns>
|
||||
<returns>
|
||||
<see langword="true" /> if the <paramref name="unicodeScalar" /> value will be encoded by this encoder; otherwise, returns <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter">
|
||||
<summary>Gets the maximum number of characters that this encoder can generate for each input code point.</summary>
|
||||
<returns>The maximum number of characters.</returns>
|
||||
</member>
|
||||
<member name="T:System.Text.Encodings.Web.TextEncoderSettings">
|
||||
<summary>Represents a filter that allows only certain Unicode code points.</summary>
|
||||
@@ -119,59 +164,67 @@
|
||||
<summary>Instantiates an empty filter (allows no code points through by default).</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.#ctor(System.Text.Encodings.Web.TextEncoderSettings)">
|
||||
<summary>Instantiates a filter by cloning the allowed list of another <see cref="T:System.Text.Encodings.Web.TextEncoderSettings"></see> object.</summary>
|
||||
<param name="other">The other <see cref="T:System.Text.Encodings.Web.TextEncoderSettings"></see> object to be cloned.</param>
|
||||
<summary>Instantiates a filter by cloning the allowed list of another <see cref="T:System.Text.Encodings.Web.TextEncoderSettings" /> object.</summary>
|
||||
<param name="other">The other <see cref="T:System.Text.Encodings.Web.TextEncoderSettings" /> object to be cloned.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.#ctor(System.Text.Unicode.UnicodeRange[])">
|
||||
<summary>Instantiates a filter where only the character ranges specified by <paramref name="allowedRanges">allowedRanges</paramref> are allowed by the filter.</summary>
|
||||
<summary>Instantiates a filter where only the character ranges specified by <paramref name="allowedRanges" /> are allowed by the filter.</summary>
|
||||
<param name="allowedRanges">The allowed character ranges.</param>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="allowedRanges">allowedRanges</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCharacter(System.Char)">
|
||||
<summary>Allows the character specified by <paramref name="character">character</paramref> through the filter.</summary>
|
||||
<summary>Allows the character specified by <paramref name="character" /> through the filter.</summary>
|
||||
<param name="character">The allowed character.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCharacters(System.Char[])">
|
||||
<summary>Allows all characters specified by <paramref name="characters">characters</paramref> through the filter.</summary>
|
||||
<summary>Allows all characters specified by <paramref name="characters" /> through the filter.</summary>
|
||||
<param name="characters">The allowed characters.</param>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="characters">characters</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="characters" /> is <see langword="null" />.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCodePoints(System.Collections.Generic.IEnumerable{System.Int32})">
|
||||
<summary>Allows all code points specified by <paramref name="codePoints">codePoints</paramref>.</summary>
|
||||
<summary>Allows all code points specified by <paramref name="codePoints" />.</summary>
|
||||
<param name="codePoints">The allowed code points.</param>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="codePoints">codePoints</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="codePoints" /> is <see langword="null" />.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowRange(System.Text.Unicode.UnicodeRange)">
|
||||
<summary>Allows all characters specified by <paramref name="range">range</paramref> through the filter.</summary>
|
||||
<summary>Allows all characters specified by <paramref name="range" /> through the filter.</summary>
|
||||
<param name="range">The range of characters to be allowed.</param>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="range">range</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="range" /> is <see langword="null" />.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowRanges(System.Text.Unicode.UnicodeRange[])">
|
||||
<summary>Allows all characters specified by <paramref name="ranges">ranges</paramref> through the filter.</summary>
|
||||
<summary>Allows all characters specified by <paramref name="ranges" /> through the filter.</summary>
|
||||
<param name="ranges">The ranges of characters to be allowed.</param>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="ranges">ranges</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="ranges" /> is <see langword="null" />.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.Clear">
|
||||
<summary>Resets this object by disallowing all characters.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidCharacter(System.Char)">
|
||||
<summary>Disallows the character <paramref name="character">character</paramref> through the filter.</summary>
|
||||
<summary>Disallows the character <paramref name="character" /> through the filter.</summary>
|
||||
<param name="character">The disallowed character.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidCharacters(System.Char[])">
|
||||
<summary>Disallows all characters specified by <paramref name="characters">characters</paramref> through the filter.</summary>
|
||||
<summary>Disallows all characters specified by <paramref name="characters" /> through the filter.</summary>
|
||||
<param name="characters">The disallowed characters.</param>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="characters">characters</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="characters" /> is <see langword="null" />.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidRange(System.Text.Unicode.UnicodeRange)">
|
||||
<summary>Disallows all characters specified by <paramref name="range">range</paramref> through the filter.</summary>
|
||||
<summary>Disallows all characters specified by <paramref name="range" /> through the filter.</summary>
|
||||
<param name="range">The range of characters to be disallowed.</param>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="range">range</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="range" /> is <see langword="null" />.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidRanges(System.Text.Unicode.UnicodeRange[])">
|
||||
<summary>Disallows all characters specified by <paramref name="ranges">ranges</paramref> through the filter.</summary>
|
||||
<summary>Disallows all characters specified by <paramref name="ranges" /> through the filter.</summary>
|
||||
<param name="ranges">The ranges of characters to be disallowed.</param>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="ranges">ranges</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="ranges" /> is <see langword="null" />.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.GetAllowedCodePoints">
|
||||
<summary>Gets an enumerator of all allowed code points.</summary>
|
||||
@@ -181,54 +234,62 @@
|
||||
<summary>Represents a URL character encoding.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.UrlEncoder.#ctor">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder"></see> class.</summary>
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.UrlEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
|
||||
<summary>Creates a new instance of UrlEncoder class with the specified settings.</summary>
|
||||
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.UrlEncoder"></see> instance encodes, primarily which characters to encode.</param>
|
||||
<returns>A new instance of the <see cref="System.Text.Encodings.Web.UrlEncoder"></see> class.</returns>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="settings">settings</paramref> is null.</exception>
|
||||
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> instance encodes, primarily which characters to encode.</param>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="settings" /> is <see langword="null" />.</exception>
|
||||
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Encodings.Web.UrlEncoder.Create(System.Text.Unicode.UnicodeRange[])">
|
||||
<summary>Creates a new instance of the UrlEncoder class that specifies characters the encoder is allowed to not encode.</summary>
|
||||
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
|
||||
<returns>A new instance of the <see cref="System.Text.Encodings.Web.UrlEncoder"></see> class.</returns>
|
||||
<exception cref="T:System.ArgumentNullException"><paramref name="allowedRanges">allowedRanges</paramref> is null.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
|
||||
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Encodings.Web.UrlEncoder.Default">
|
||||
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder"></see> class.</summary>
|
||||
<returns>A built-in instance of the <see cref="System.Text.Encodings.Web.UrlEncoder"></see> class.</returns>
|
||||
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</summary>
|
||||
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
|
||||
</member>
|
||||
<member name="T:System.Text.Unicode.UnicodeRange">
|
||||
<summary>Represents a contiguous range of Unicode code points.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Unicode.UnicodeRange.#ctor(System.Int32,System.Int32)">
|
||||
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange"></see> that includes a specified number of characters starting at a specified Unicode code point.</summary>
|
||||
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange" /> that includes a specified number of characters starting at a specified Unicode code point.</summary>
|
||||
<param name="firstCodePoint">The first code point in the range.</param>
|
||||
<param name="length">The number of code points in the range.</param>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="firstCodePoint">firstCodePoint</paramref> is less than zero or greater than 0xFFFF.
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="firstCodePoint" /> is less than zero or greater than 0xFFFF.
|
||||
|
||||
-or-
|
||||
<paramref name="length">length</paramref> is less than zero.
|
||||
|
||||
<paramref name="length" /> is less than zero.
|
||||
|
||||
-or-
|
||||
<paramref name="firstCodePoint">firstCodePoint</paramref> plus <paramref name="length">length</paramref> is greater than 0xFFFF.</exception>
|
||||
|
||||
<paramref name="firstCodePoint" /> plus <paramref name="length" /> is greater than 0xFFFF.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Unicode.UnicodeRange.Create(System.Char,System.Char)">
|
||||
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange"></see> instance from a span of characters.</summary>
|
||||
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange" /> instance from a span of characters.</summary>
|
||||
<param name="firstCharacter">The first character in the range.</param>
|
||||
<param name="lastCharacter">The last character in the range.</param>
|
||||
<returns>A range that includes all characters between <paramref name="firstCharacter">firstCharacter</paramref> and <paramref name="lastCharacter">lastCharacter</paramref>.</returns>
|
||||
<exception cref="System.ArgumentOutOfRangeException"><paramref name="lastCharacter">lastCharacter</paramref> precedes <paramref name="firstCharacter">firstCharacter</paramref>.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="lastCharacter" /> precedes <paramref name="firstCharacter" />.</exception>
|
||||
<returns>A range that includes all characters between <paramref name="firstCharacter" /> and <paramref name="lastCharacter" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Unicode.UnicodeRange.FirstCodePoint">
|
||||
<summary>Gets the first code point in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange"></see> instance.</summary>
|
||||
<summary>Gets the first code point in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange" /> instance.</summary>
|
||||
<returns>The first code point in the range.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Unicode.UnicodeRange.Length">
|
||||
<summary>Gets the number of code points in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange"></see> instance.</summary>
|
||||
<summary>Gets the number of code points in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange" /> instance.</summary>
|
||||
<returns>The number of code points in the range.</returns>
|
||||
</member>
|
||||
<member name="T:System.Text.Unicode.UnicodeRanges">
|
||||
<summary>Provides static properties that return predefined <see cref="T:System.Text.Unicode.UnicodeRange"></see> instances that correspond to blocks from the Unicode specification.</summary>
|
||||
<summary>Provides static properties that return predefined <see cref="T:System.Text.Unicode.UnicodeRange" /> instances that correspond to blocks from the Unicode specification.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Unicode.UnicodeRanges.All">
|
||||
<summary>Gets a range that consists of the entire Basic Multilingual Plane (BMP), from U+0000 to U+FFFF).</summary>
|
||||
@@ -246,6 +307,9 @@
|
||||
<summary>Gets the Arabic Extended-A Unicode block (U+08A0-U+08FF).</summary>
|
||||
<returns>The Arabic Extended-A Unicode block (U+08A0-U+08FF).</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicExtendedB">
|
||||
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Arabic Extended-B' Unicode block (U+0870..U+089F).</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicPresentationFormsA">
|
||||
<summary>Gets the Arabic Presentation Forms-A Unicode block (U+FB50-U+FDFF).</summary>
|
||||
<returns>The Arabic Presentation Forms-A Unicode block (U+FB50-U+FDFF).</returns>
|
||||
@@ -406,6 +470,9 @@
|
||||
<summary>Gets the Cyrillic Extended-B Unicode block (U+A640-U+A69F).</summary>
|
||||
<returns>The Cyrillic Extended-B Unicode block (U+A640-U+A69F).</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Unicode.UnicodeRanges.CyrillicExtendedC">
|
||||
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Cyrillic Extended-C' Unicode block (U+1C80..U+1C8F).</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Unicode.UnicodeRanges.CyrillicSupplement">
|
||||
<summary>Gets the Cyrillic Supplement Unicode block (U+0500-U+052F).</summary>
|
||||
<returns>The Cyrillic Supplement Unicode block (U+0500-U+052F).</returns>
|
||||
@@ -458,6 +525,9 @@
|
||||
<summary>Gets the Georgian Unicode block (U+10A0-U+10FF).</summary>
|
||||
<returns>The Georgian Unicode block (U+10A0-U+10FF).</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Unicode.UnicodeRanges.GeorgianExtended">
|
||||
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Georgian Extended' Unicode block (U+1C90..U+1CBF).</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Unicode.UnicodeRanges.GeorgianSupplement">
|
||||
<summary>Gets the Georgian Supplement Unicode block (U+2D00-U+2D2F).</summary>
|
||||
<returns>The Georgian Supplement Unicode block (U+2D00-U+2D2F).</returns>
|
||||
@@ -782,6 +852,9 @@
|
||||
<summary>Gets the Syriac Unicode block (U+0700-U+074F).</summary>
|
||||
<returns>The Syriac Unicode block (U+0700-U+074F).</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Unicode.UnicodeRanges.SyriacSupplement">
|
||||
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Syriac Supplement' Unicode block (U+0860..U+086F).</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Unicode.UnicodeRanges.Tagalog">
|
||||
<summary>Gets the Tagalog Unicode block (U+1700-U+171F).</summary>
|
||||
<returns>The Tagalog Unicode block (U+1700-U+171F).</returns>
|
||||
|
||||
Binary file not shown.
@@ -4,6 +4,10 @@
|
||||
<name>System.Text.Json</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.Runtime.InteropServices.JsonMarshal" />
|
||||
<member name="M:System.Runtime.InteropServices.JsonMarshal.GetRawUtf8Value(System.Text.Json.JsonElement)">
|
||||
<param name="element" />
|
||||
</member>
|
||||
<member name="T:System.Text.Json.JsonCommentHandling">
|
||||
<summary>Defines how the <see cref="T:System.Text.Json.Utf8JsonReader" /> struct handles comments.</summary>
|
||||
</member>
|
||||
@@ -81,6 +85,7 @@
|
||||
<paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
<paramref name="options" /> contains unsupported options.</exception>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A task to produce a JsonDocument representation of the JSON value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonDocument.ParseValue(System.Text.Json.Utf8JsonReader@)">
|
||||
@@ -145,6 +150,10 @@ The current <paramref name="reader" /> token does not start or represent a value
|
||||
<summary>Gets a JsonElement that can be safely stored beyond the lifetime of the original <see cref="T:System.Text.Json.JsonDocument" />.</summary>
|
||||
<returns>A JsonElement that can be safely stored beyond the lifetime of the original <see cref="T:System.Text.Json.JsonDocument" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonElement.DeepEquals(System.Text.Json.JsonElement,System.Text.Json.JsonElement)">
|
||||
<param name="element1" />
|
||||
<param name="element2" />
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonElement.EnumerateArray">
|
||||
<summary>Gets an enumerator to enumerate the values in the JSON array represented by this JsonElement.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Array" />.</exception>
|
||||
@@ -265,6 +274,7 @@ The current <paramref name="reader" /> token does not start or represent a value
|
||||
<exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
|
||||
<returns>A <see cref="T:System.Text.Json.JsonElement" /> representing the value of the requested property.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonElement.GetPropertyCount" />
|
||||
<member name="M:System.Text.Json.JsonElement.GetRawText">
|
||||
<summary>Gets a string that represents the original input data backing this value.</summary>
|
||||
<exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
|
||||
@@ -678,15 +688,19 @@ The current <paramref name="reader" /> token does not start or represent a value
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="info" /> is <see langword="null" />.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonException.#ctor(System.String)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.JsonException" /> class with a specified error message.</summary>
|
||||
<param name="message">The context-specific error message.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonException.#ctor(System.String,System.Exception)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.JsonException" /> class, with a specified error message and a reference to the inner exception that is the cause of this exception.</summary>
|
||||
<param name="message">The context-specific error message.</param>
|
||||
<param name="innerException">The exception that caused the current exception.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonException.#ctor(System.String,System.String,System.Nullable{System.Int64},System.Nullable{System.Int64},System.Exception)">
|
||||
<summary>Creates a new exception object to relay error information to the user that includes a specified inner exception.</summary>
|
||||
<param name="message">The context-specific error message.</param>
|
||||
<param name="path">The path where the invalid JSON was encountered.</param>
|
||||
<param name="lineNumber">The line number (starting at 0) at which the invalid JSON was encountered when deserializing.</param>
|
||||
<param name="bytePositionInLine">The byte count (starting at 0) within the current line where the invalid JSON was encountered.</param>
|
||||
<param name="innerException">The exception that caused the current exception.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonException.#ctor(System.String,System.String,System.Nullable{System.Int64},System.Nullable{System.Int64})">
|
||||
<summary>Creates a new exception object to relay error information to the user.</summary>
|
||||
<param name="message">The context-specific error message.</param>
|
||||
@@ -694,13 +708,9 @@ The current <paramref name="reader" /> token does not start or represent a value
|
||||
<param name="lineNumber">The line number (starting at 0) at which the invalid JSON was encountered when deserializing.</param>
|
||||
<param name="bytePositionInLine">The byte count within the current line (starting at 0) where the invalid JSON was encountered.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonException.#ctor(System.String,System.String,System.Nullable{System.Int64},System.Nullable{System.Int64},System.Exception)">
|
||||
<summary>Creates a new exception object to relay error information to the user that includes a specified inner exception.</summary>
|
||||
<member name="M:System.Text.Json.JsonException.#ctor(System.String)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.JsonException" /> class with a specified error message.</summary>
|
||||
<param name="message">The context-specific error message.</param>
|
||||
<param name="path">The path where the invalid JSON was encountered.</param>
|
||||
<param name="lineNumber">The line number (starting at 0) at which the invalid JSON was encountered when deserializing.</param>
|
||||
<param name="bytePositionInLine">The byte count (starting at 0) within the current line where the invalid JSON was encountered.</param>
|
||||
<param name="innerException">The exception that caused the current exception.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
|
||||
<summary>Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with information about the exception.</summary>
|
||||
@@ -799,6 +809,7 @@ The current <paramref name="reader" /> token does not start or represent a value
|
||||
<member name="T:System.Text.Json.JsonReaderOptions">
|
||||
<summary>Provides the ability for the user to define custom behavior when reading JSON.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonReaderOptions.AllowMultipleValues" />
|
||||
<member name="P:System.Text.Json.JsonReaderOptions.AllowTrailingCommas">
|
||||
<summary>Gets or sets a value that defines whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read.</summary>
|
||||
<returns>
|
||||
@@ -1448,6 +1459,7 @@ A value could not be read from the reader.</exception>
|
||||
<paramref name="utf8Json" /> or <paramref name="jsonTypeInfo" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.Text.Json.JsonException">The JSON is invalid,
|
||||
or when there is remaining data in the Stream.</exception>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A <paramref name="jsonTypeInfo" /> representation of the JSON value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.DeserializeAsync(System.IO.Stream,System.Type,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
|
||||
@@ -1468,6 +1480,7 @@ A value could not be read from the reader.</exception>
|
||||
|
||||
There is remaining data in the stream.</exception>
|
||||
<exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <paramref name="returnType" /> or its serializable members.</exception>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A <paramref name="returnType" /> representation of the JSON value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.DeserializeAsync(System.IO.Stream,System.Type,System.Text.Json.Serialization.JsonSerializerContext,System.Threading.CancellationToken)">
|
||||
@@ -1482,6 +1495,7 @@ There is remaining data in the stream.</exception>
|
||||
<exception cref="T:System.Text.Json.JsonException">The JSON is invalid, the <paramref name="returnType" /> is not compatible with the JSON, or there is remaining data in the Stream.</exception>
|
||||
<exception cref="T:System.NotSupportedException">There is no compatible <see cref="T:System.Text.Json.Serialization.JsonConverter" /> for <paramref name="returnType" /> or its serializable members.</exception>
|
||||
<exception cref="T:System.InvalidOperationException">The <see cref="M:System.Text.Json.Serialization.JsonSerializerContext.GetTypeInfo(System.Type)" /> method on the provided <paramref name="context" /> did not return a compatible <see cref="T:System.Text.Json.Serialization.Metadata.JsonTypeInfo" /> for <paramref name="returnType" />.</exception>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A <paramref name="returnType" /> representation of the JSON value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.DeserializeAsync``1(System.IO.Stream,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
|
||||
@@ -1502,6 +1516,7 @@ There is remaining data in the stream.</exception>
|
||||
<exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="utf8Json" />is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A <typeparamref name="TValue" /> representation of the JSON value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.DeserializeAsync``1(System.IO.Stream,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0},System.Threading.CancellationToken)">
|
||||
@@ -1515,8 +1530,16 @@ There is remaining data in the stream.</exception>
|
||||
<paramref name="utf8Json" /> or <paramref name="jsonTypeInfo" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.Text.Json.JsonException">The JSON is invalid, <typeparamref name="TValue" /> is not compatible with the JSON, or there is remaining data in the Stream.</exception>
|
||||
<exception cref="T:System.NotSupportedException">There is no compatible <see cref="T:System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A <typeparamref name="TValue" /> representation of the JSON value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.DeserializeAsyncEnumerable``1(System.IO.Stream,System.Boolean,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
|
||||
<param name="utf8Json" />
|
||||
<param name="topLevelValues" />
|
||||
<param name="options" />
|
||||
<param name="cancellationToken" />
|
||||
<typeparam name="TValue" />
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.DeserializeAsyncEnumerable``1(System.IO.Stream,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
|
||||
<summary>Wraps the UTF-8 encoded text into an <see cref="T:System.Collections.Generic.IAsyncEnumerable`1" /> that can be used to deserialize root-level JSON arrays in a streaming manner.</summary>
|
||||
<param name="utf8Json">JSON data to parse.</param>
|
||||
@@ -1525,8 +1548,16 @@ There is remaining data in the stream.</exception>
|
||||
<typeparam name="TValue">The element type to deserialize asynchronously.</typeparam>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="utf8Json" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>An <see cref="T:System.Collections.Generic.IAsyncEnumerable`1" /> representation of the provided JSON array.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.DeserializeAsyncEnumerable``1(System.IO.Stream,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0},System.Boolean,System.Threading.CancellationToken)">
|
||||
<param name="utf8Json" />
|
||||
<param name="jsonTypeInfo" />
|
||||
<param name="topLevelValues" />
|
||||
<param name="cancellationToken" />
|
||||
<typeparam name="TValue" />
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.DeserializeAsyncEnumerable``1(System.IO.Stream,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0},System.Threading.CancellationToken)">
|
||||
<summary>Wraps the UTF-8 encoded text into an <see cref="T:System.Collections.Generic.IAsyncEnumerable`1" /> that can be used to deserialize root-level JSON arrays in a streaming manner.</summary>
|
||||
<param name="utf8Json">JSON data to parse.</param>
|
||||
@@ -1535,6 +1566,7 @@ There is remaining data in the stream.</exception>
|
||||
<typeparam name="TValue">The element type to deserialize asynchronously.</typeparam>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="utf8Json" /> or <paramref name="jsonTypeInfo" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>An <see cref="T:System.Collections.Generic.IAsyncEnumerable`1" /> representation of the provided JSON array.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.Serialize(System.IO.Stream,System.Object,System.Text.Json.Serialization.Metadata.JsonTypeInfo)">
|
||||
@@ -1697,6 +1729,52 @@ There is remaining data in the stream.</exception>
|
||||
<paramref name="writer" /> or <paramref name="jsonTypeInfo" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.NotSupportedException">There is no compatible <see cref="T:System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeAsync(System.IO.Pipelines.PipeWriter,System.Object,System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Threading.CancellationToken)">
|
||||
<summary>Converts the provided value to UTF-8 encoded JSON text and write it to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
<param name="utf8Json">The UTF-8 <see cref="T:System.IO.Pipelines.PipeWriter" /> to write to.</param>
|
||||
<param name="value">The value to convert.</param>
|
||||
<param name="jsonTypeInfo">Metadata about the type to convert.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> that can be used to cancel the write operation.</param>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="utf8Json" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.InvalidCastException">
|
||||
<paramref name="value" /> does not match the type of <paramref name="jsonTypeInfo" />.</exception>
|
||||
<returns>A task that represents the asynchronous write operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeAsync(System.IO.Pipelines.PipeWriter,System.Object,System.Type,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
|
||||
<summary>Converts the provided value to UTF-8 encoded JSON text and write it to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
<param name="utf8Json">The UTF-8 <see cref="T:System.IO.Pipelines.PipeWriter" /> to write to.</param>
|
||||
<param name="value">The value to convert.</param>
|
||||
<param name="inputType">The type of the <paramref name="value" /> to convert.</param>
|
||||
<param name="options">Options to control the conversion behavior.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> that can be used to cancel the write operation.</param>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
<paramref name="inputType" /> is not compatible with <paramref name="value" />.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="utf8Json" /> or <paramref name="inputType" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.NotSupportedException">
|
||||
<para>There is no compatible <see cref="T:System.Text.Json.Serialization.JsonConverter" /></para>
|
||||
<para>for <paramref name="inputType" /> or its serializable members.</para>
|
||||
</exception>
|
||||
<returns>A task that represents the asynchronous write operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeAsync(System.IO.Pipelines.PipeWriter,System.Object,System.Type,System.Text.Json.Serialization.JsonSerializerContext,System.Threading.CancellationToken)">
|
||||
<summary>Converts the provided value to UTF-8 encoded JSON text and write it to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
<param name="utf8Json">The UTF-8 <see cref="T:System.IO.Pipelines.PipeWriter" /> to write to.</param>
|
||||
<param name="value">The value to convert.</param>
|
||||
<param name="inputType">The type of the <paramref name="value" /> to convert.</param>
|
||||
<param name="context">A metadata provider for serializable types.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> that can be used to cancel the write operation.</param>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
<paramref name="inputType" /> is not compatible with <paramref name="value" />.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="utf8Json" />, <paramref name="inputType" />, or <paramref name="context" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.NotSupportedException">
|
||||
<para>There is no compatible <see cref="T:System.Text.Json.Serialization.JsonConverter" /></para>
|
||||
<para>for <paramref name="inputType" /> or its serializable members.</para>
|
||||
</exception>
|
||||
<returns>A task that represents the asynchronous write operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeAsync(System.IO.Stream,System.Object,System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Threading.CancellationToken)">
|
||||
<summary>Converts the provided value to UTF-8 encoded JSON text and writes it to the <see cref="T:System.IO.Stream" />.</summary>
|
||||
<param name="utf8Json">The UTF-8 <see cref="T:System.IO.Stream" /> to write to.</param>
|
||||
@@ -1707,6 +1785,7 @@ There is remaining data in the stream.</exception>
|
||||
<paramref name="utf8Json" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.InvalidCastException">
|
||||
<paramref name="value" /> does not match the type of <paramref name="jsonTypeInfo" />.</exception>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A task that represents the asynchronous write operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeAsync(System.IO.Stream,System.Object,System.Type,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
|
||||
@@ -1721,6 +1800,7 @@ There is remaining data in the stream.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="utf8Json" /> or <paramref name="inputType" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <paramref name="inputType" /> or its serializable members.</exception>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A task that represents the asynchronous write operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeAsync(System.IO.Stream,System.Object,System.Type,System.Text.Json.Serialization.JsonSerializerContext,System.Threading.CancellationToken)">
|
||||
@@ -1735,6 +1815,33 @@ There is remaining data in the stream.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="utf8Json" />, <paramref name="inputType" />, or <paramref name="context" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.NotSupportedException">There is no compatible <see cref="T:System.Text.Json.Serialization.JsonConverter" /> for <paramref name="inputType" /> or its serializable members.</exception>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A task that represents the asynchronous write operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeAsync``1(System.IO.Pipelines.PipeWriter,``0,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
|
||||
<summary>Converts the provided value to UTF-8 encoded JSON text and write it to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
<param name="utf8Json">The UTF-8 <see cref="T:System.IO.Pipelines.PipeWriter" /> to write to.</param>
|
||||
<param name="value">The value to convert.</param>
|
||||
<param name="options">Options to control the conversion behavior.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> that can be used to cancel the write operation.</param>
|
||||
<typeparam name="TValue">The type of the value to serialize.</typeparam>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="utf8Json" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.NotSupportedException">
|
||||
<para>There is no compatible <see cref="T:System.Text.Json.Serialization.JsonConverter" /></para>
|
||||
<para>for <typeparamref name="TValue" /> or its serializable members.</para>
|
||||
</exception>
|
||||
<returns>A task that represents the asynchronous write operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeAsync``1(System.IO.Pipelines.PipeWriter,``0,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0},System.Threading.CancellationToken)">
|
||||
<summary>Converts the provided value to UTF-8 encoded JSON text and write it to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
<param name="utf8Json">The UTF-8 <see cref="T:System.IO.Pipelines.PipeWriter" /> to write to.</param>
|
||||
<param name="value">The value to convert.</param>
|
||||
<param name="jsonTypeInfo">Metadata about the type to convert.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> that can be used to cancel the write operation.</param>
|
||||
<typeparam name="TValue">The type of the value to serialize.</typeparam>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="utf8Json" /> is <see langword="null" />.</exception>
|
||||
<returns>A task that represents the asynchronous write operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeAsync``1(System.IO.Stream,``0,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
|
||||
@@ -1747,6 +1854,7 @@ There is remaining data in the stream.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="utf8Json" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A task that represents the asynchronous write operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeAsync``1(System.IO.Stream,``0,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0},System.Threading.CancellationToken)">
|
||||
@@ -1759,6 +1867,7 @@ There is remaining data in the stream.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="utf8Json" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.NotSupportedException">There is no compatible <see cref="T:System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A task that represents the asynchronous write operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeToDocument(System.Object,System.Text.Json.Serialization.Metadata.JsonTypeInfo)">
|
||||
@@ -1823,7 +1932,7 @@ There is remaining data in the stream.</exception>
|
||||
<returns>A <see cref="T:System.Text.Json.JsonElement" /> representation of the value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeToElement(System.Object,System.Type,System.Text.Json.JsonSerializerOptions)">
|
||||
<summary>Converts the provided value into a <see cref="T:System.Text.Json.JsonDocument" />.</summary>
|
||||
<summary>Converts the provided value into a <see cref="T:System.Text.Json.JsonElement" />.</summary>
|
||||
<param name="value">The value to convert.</param>
|
||||
<param name="inputType">The type of the <paramref name="value" /> to convert.</param>
|
||||
<param name="options">Options to control the conversion behavior.</param>
|
||||
@@ -1832,10 +1941,10 @@ There is remaining data in the stream.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="inputType" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.NotSupportedException">There is no compatible <see cref="T:System.Text.Json.Serialization.JsonConverter" /> for <paramref name="inputType" /> or its serializable members.</exception>
|
||||
<returns>A <see cref="T:System.Text.Json.JsonDocument" /> representation of the value.</returns>
|
||||
<returns>A <see cref="T:System.Text.Json.JsonElement" /> representation of the value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeToElement(System.Object,System.Type,System.Text.Json.Serialization.JsonSerializerContext)">
|
||||
<summary>Converts the provided value into a <see cref="T:System.Text.Json.JsonDocument" />.</summary>
|
||||
<summary>Converts the provided value into a <see cref="T:System.Text.Json.JsonElement" />.</summary>
|
||||
<param name="value">The value to convert.</param>
|
||||
<param name="inputType">The type of the <paramref name="value" /> to convert.</param>
|
||||
<param name="context">A metadata provider for serializable types.</param>
|
||||
@@ -1843,25 +1952,25 @@ There is remaining data in the stream.</exception>
|
||||
<exception cref="T:System.InvalidOperationException">The <see cref="M:System.Text.Json.Serialization.JsonSerializerContext.GetTypeInfo(System.Type)" /> method of the provided <paramref name="context" /> returns <see langword="null" /> for the type to convert.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="inputType" /> or <paramref name="context" /> is <see langword="null" />.</exception>
|
||||
<returns>A <see cref="T:System.Text.Json.JsonDocument" /> representation of the value.</returns>
|
||||
<returns>A <see cref="T:System.Text.Json.JsonElement" /> representation of the value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeToElement``1(``0,System.Text.Json.JsonSerializerOptions)">
|
||||
<summary>Converts the provided value into a <see cref="T:System.Text.Json.JsonDocument" />.</summary>
|
||||
<summary>Converts the provided value into a <see cref="T:System.Text.Json.JsonElement" />.</summary>
|
||||
<param name="value">The value to convert.</param>
|
||||
<param name="options">Options to control the conversion behavior.</param>
|
||||
<typeparam name="TValue">The type of the value to serialize.</typeparam>
|
||||
<exception cref="T:System.NotSupportedException">There is no compatible <see cref="T:System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
|
||||
<returns>A <see cref="T:System.Text.Json.JsonDocument" /> representation of the JSON value.</returns>
|
||||
<returns>A <see cref="T:System.Text.Json.JsonElement" /> representation of the JSON value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeToElement``1(``0,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})">
|
||||
<summary>Converts the provided value into a <see cref="T:System.Text.Json.JsonDocument" />.</summary>
|
||||
<summary>Converts the provided value into a <see cref="T:System.Text.Json.JsonElement" />.</summary>
|
||||
<param name="value">The value to convert.</param>
|
||||
<param name="jsonTypeInfo">Metadata about the type to convert.</param>
|
||||
<typeparam name="TValue">The type of the value to serialize.</typeparam>
|
||||
<exception cref="T:System.NotSupportedException">There is no compatible <see cref="T:System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="jsonTypeInfo" /> is <see langword="null" />.</exception>
|
||||
<returns>A <see cref="T:System.Text.Json.JsonDocument" /> representation of the value.</returns>
|
||||
<returns>A <see cref="T:System.Text.Json.JsonElement" /> representation of the value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.JsonSerializer.SerializeToNode(System.Object,System.Text.Json.Serialization.Metadata.JsonTypeInfo)">
|
||||
<summary>Converts the provided value into a <see cref="T:System.Text.Json.Nodes.JsonNode" />.</summary>
|
||||
@@ -1968,7 +2077,7 @@ There is remaining data in the stream.</exception>
|
||||
<returns>A UTF-8 representation of the value.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonSerializer.IsReflectionEnabledByDefault">
|
||||
<summary>Indicates whether unconfigured <see cref="T:System.Text.Json.JsonSerializerOptions" /> instances should be set to use the reflection-based <see cref="T:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver" />.</summary>
|
||||
<summary>Gets a value that indicates whether unconfigured <see cref="T:System.Text.Json.JsonSerializerOptions" /> instances should default to the reflection-based <see cref="T:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver" />.</summary>
|
||||
</member>
|
||||
<member name="T:System.Text.Json.JsonSerializerDefaults">
|
||||
<summary>Specifies scenario-based default serialization options that can be used to construct a <see cref="T:System.Text.Json.JsonSerializerOptions" /> instance.</summary>
|
||||
@@ -2048,6 +2157,10 @@ There is remaining data in the stream.</exception>
|
||||
<returns>
|
||||
<see langword="true" /> if a contract for <paramref name="type" /> was found, or <see langword="false" /> otherwise.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.AllowOutOfOrderMetadataProperties">
|
||||
<summary>Allows JSON metadata properties to be specified after regular properties in a deserialized JSON object.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">Thrown if this property is set after serialization or deserialization has occurred.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.AllowTrailingCommas">
|
||||
<summary>Get or sets a value that indicates whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being deserialized.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
|
||||
@@ -2102,7 +2215,7 @@ There is remaining data in the stream.</exception>
|
||||
<see langword="true" /> if read-only fields are ignored during serialization; <see langword="false" /> otherwise.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.IgnoreReadOnlyProperties">
|
||||
<summary>Gets a value that indicates whether read-only properties are ignored during serialization. The default value is <see langword="false" />.</summary>
|
||||
<summary>Gets or sets a value that indicates whether read-only properties are ignored during serialization. The default value is <see langword="false" />.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
|
||||
<returns>
|
||||
<see langword="true" /> if read-only properties are ignored during serialization; otherwise, <see langword="false" />.</returns>
|
||||
@@ -2114,6 +2227,18 @@ There is remaining data in the stream.</exception>
|
||||
<returns>
|
||||
<see langword="true" /> if fields are included during serialization; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.IndentCharacter">
|
||||
<summary>Defines the indentation character being used when <see cref="P:System.Text.Json.JsonSerializerOptions.WriteIndented" /> is enabled. Defaults to the space character.</summary>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="value" /> contains an invalid character.</exception>
|
||||
<exception cref="T:System.InvalidOperationException">Thrown if this property is set after serialization or deserialization has occurred.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.IndentSize">
|
||||
<summary>Defines the indentation size being used when <see cref="P:System.Text.Json.JsonSerializerOptions.WriteIndented" /> is enabled. Defaults to two.</summary>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="value" /> is out of the allowed range.</exception>
|
||||
<exception cref="T:System.InvalidOperationException">Thrown if this property is set after serialization or deserialization has occurred.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.IsReadOnly">
|
||||
<summary>Gets a value that indicates whether the current instance has been locked for user modification.</summary>
|
||||
</member>
|
||||
@@ -2123,6 +2248,15 @@ There is remaining data in the stream.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">The max depth is set to a negative value.</exception>
|
||||
<returns>The maximum depth allowed when serializing or deserializing JSON.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.NewLine">
|
||||
<summary>
|
||||
<para>Gets or sets the new line string to use when <see cref="P:System.Text.Json.JsonSerializerOptions.WriteIndented" /> is <see langword="true" />.</para>
|
||||
<para>The default is the value of <see cref="P:System.Environment.NewLine" />.</para>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentNullException">Thrown when the new line string is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the new line string is not <c>\n</c> or <c>\r\n</c>.</exception>
|
||||
<exception cref="T:System.InvalidOperationException">Thrown if this property is set after serialization or deserialization has occurred.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.NumberHandling">
|
||||
<summary>Gets or sets an object that specifies how number types should be handled when serializing or deserializing.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">This property is set after serialization or deserialization has occurred.</exception>
|
||||
@@ -2149,6 +2283,14 @@ There is remaining data in the stream.</exception>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.ReferenceHandler">
|
||||
<summary>Gets or sets an object that specifies how object references are handled when reading and writing JSON.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.RespectNullableAnnotations">
|
||||
<summary>Gets or sets a value that indicates whether nullability annotations should be respected during serialization and deserialization.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">This property is set after serialization or deserialization has occurred.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.RespectRequiredConstructorParameters">
|
||||
<summary>Gets or sets a value that indicates whether non-optional constructor parameters should be specified during deserialization.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">This property is set after serialization or deserialization has occurred.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.TypeInfoResolver">
|
||||
<summary>Gets or sets the <see cref="T:System.Text.Json.Serialization.Metadata.JsonTypeInfo" /> contract resolver used by this instance.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The property is set after serialization or deserialization has occurred.</exception>
|
||||
@@ -2162,6 +2304,9 @@ There is remaining data in the stream.</exception>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.UnmappedMemberHandling">
|
||||
<summary>Gets or sets an object that specifies how <see cref="T:System.Text.Json.JsonSerializer" /> handles JSON properties that cannot be mapped to a specific .NET member when deserializing object types.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.Web">
|
||||
<summary>Gets a read-only, singleton instance of <see cref="T:System.Text.Json.JsonSerializerOptions" /> that uses the web configuration.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonSerializerOptions.WriteIndented">
|
||||
<summary>Gets or sets a value that indicates whether JSON should use pretty printing. By default, JSON is serialized without any extra white space.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
|
||||
@@ -2241,15 +2386,33 @@ There is remaining data in the stream.</exception>
|
||||
<summary>Gets or sets the encoder to use when escaping strings, or <see langword="null" /> to use the default encoder.</summary>
|
||||
<returns>The JavaScript character encoder used to override the escaping behavior.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonWriterOptions.IndentCharacter">
|
||||
<summary>Defines the indentation character used by <see cref="T:System.Text.Json.Utf8JsonWriter" /> when <see cref="P:System.Text.Json.JsonWriterOptions.Indented" /> is enabled. Defaults to the space character.</summary>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="value" /> contains an invalid character.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonWriterOptions.Indented">
|
||||
<summary>Gets or sets a value that indicates whether the <see cref="T:System.Text.Json.Utf8JsonWriter" /> should format the JSON output, which includes indenting nested JSON tokens, adding new lines, and adding white space between property names and values.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if the JSON output is formatted; <see langword="false" /> if the JSON is written without any extra white space. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonWriterOptions.IndentSize">
|
||||
<summary>Defines the indentation size used by <see cref="T:System.Text.Json.Utf8JsonWriter" /> when <see cref="P:System.Text.Json.JsonWriterOptions.Indented" /> is enabled. Defaults to two.</summary>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="value" /> is out of the allowed range.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonWriterOptions.MaxDepth">
|
||||
<summary>Gets or sets the maximum depth allowed when writing JSON, with the default (that is, 0) indicating a max depth of 1000.</summary>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the max depth is set to a negative value.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonWriterOptions.NewLine">
|
||||
<summary>
|
||||
<para>Gets or sets the new line string to use when <see cref="P:System.Text.Json.JsonWriterOptions.Indented" /> is <see langword="true" />.</para>
|
||||
<para>The default is the value of <see cref="P:System.Environment.NewLine" />.</para>
|
||||
</summary>
|
||||
<exception cref="T:System.ArgumentNullException">Thrown when the new line string is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the new line string is not <c>\n</c> or <c>\r\n</c>.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.JsonWriterOptions.SkipValidation">
|
||||
<summary>Gets or sets a value that indicates whether the <see cref="T:System.Text.Json.Utf8JsonWriter" /> should skip structural validation and allow the user to write invalid JSON.</summary>
|
||||
<returns>
|
||||
@@ -2262,10 +2425,19 @@ There is remaining data in the stream.</exception>
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Nodes.JsonArray" /> class that is empty.</summary>
|
||||
<param name="options">Options to control the behavior.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonArray.#ctor(System.ReadOnlySpan{System.Text.Json.Nodes.JsonNode})">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Nodes.JsonArray" /> class that contains items from the specified span.</summary>
|
||||
<param name="items">The items to add to the new <see cref="T:System.Text.Json.Nodes.JsonArray" />.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonArray.#ctor(System.Text.Json.Nodes.JsonNode[])">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Nodes.JsonArray" /> class that contains items from the specified array.</summary>
|
||||
<param name="items">The items to add to the new <see cref="T:System.Text.Json.Nodes.JsonArray" />.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonArray.#ctor(System.Text.Json.Nodes.JsonNodeOptions,System.ReadOnlySpan{System.Text.Json.Nodes.JsonNode})">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Nodes.JsonArray" /> class that contains items from the specified params span.</summary>
|
||||
<param name="options">Options to control the behavior.</param>
|
||||
<param name="items">The items to add to the new <see cref="T:System.Text.Json.Nodes.JsonArray" />.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonArray.#ctor(System.Text.Json.Nodes.JsonNodeOptions,System.Text.Json.Nodes.JsonNode[])">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Nodes.JsonArray" /> class that contains items from the specified params array.</summary>
|
||||
<param name="options">Options to control the behavior.</param>
|
||||
@@ -2748,7 +2920,7 @@ There is remaining data in the stream.</exception>
|
||||
<param name="documentOptions">Options to control the document behavior during parsing.</param>
|
||||
<exception cref="T:System.Text.Json.JsonException">
|
||||
<paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
|
||||
<returns>A <see cref="T:System.Text.Json.Nodes.JsonNode" /> representation of the JSON value.</returns>
|
||||
<returns>A <see cref="T:System.Text.Json.Nodes.JsonNode" /> representation of the JSON value, or null if the input represents the null JSON value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonNode.Parse(System.ReadOnlySpan{System.Byte},System.Nullable{System.Text.Json.Nodes.JsonNodeOptions},System.Text.Json.JsonDocumentOptions)">
|
||||
<summary>Parses text representing a single JSON value.</summary>
|
||||
@@ -2757,7 +2929,7 @@ There is remaining data in the stream.</exception>
|
||||
<param name="documentOptions">Options to control the document behavior during parsing.</param>
|
||||
<exception cref="T:System.Text.Json.JsonException">
|
||||
<paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
|
||||
<returns>A <see cref="T:System.Text.Json.Nodes.JsonNode" /> representation of the JSON value.</returns>
|
||||
<returns>A <see cref="T:System.Text.Json.Nodes.JsonNode" /> representation of the JSON value, or null if the input represents the null JSON value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonNode.Parse(System.String,System.Nullable{System.Text.Json.Nodes.JsonNodeOptions},System.Text.Json.JsonDocumentOptions)">
|
||||
<summary>Parses text representing a single JSON value.</summary>
|
||||
@@ -2768,7 +2940,7 @@ There is remaining data in the stream.</exception>
|
||||
<paramref name="json" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.Text.Json.JsonException">
|
||||
<paramref name="json" /> does not represent a valid single JSON value.</exception>
|
||||
<returns>A <see cref="T:System.Text.Json.Nodes.JsonNode" /> representation of the JSON value.</returns>
|
||||
<returns>A <see cref="T:System.Text.Json.Nodes.JsonNode" /> representation of the JSON value, or null if the input represents the null JSON value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonNode.Parse(System.Text.Json.Utf8JsonReader@,System.Nullable{System.Text.Json.Nodes.JsonNodeOptions})">
|
||||
<summary>Parses one JSON value (including objects or arrays) from the provided reader.</summary>
|
||||
@@ -2778,7 +2950,7 @@ There is remaining data in the stream.</exception>
|
||||
<paramref name="reader" /> is using unsupported options.</exception>
|
||||
<exception cref="T:System.ArgumentException">The current <paramref name="reader" /> token does not start or represent a value.</exception>
|
||||
<exception cref="T:System.Text.Json.JsonException">A value could not be read from the reader.</exception>
|
||||
<returns>The <see cref="T:System.Text.Json.Nodes.JsonNode" /> from the reader.</returns>
|
||||
<returns>The <see cref="T:System.Text.Json.Nodes.JsonNode" /> from the reader, or null if the input represents the null JSON value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonNode.ParseAsync(System.IO.Stream,System.Nullable{System.Text.Json.Nodes.JsonNodeOptions},System.Text.Json.JsonDocumentOptions,System.Threading.CancellationToken)">
|
||||
<summary>Parses a <see cref="T:System.IO.Stream" /> as UTF-8 encoded data representing a single JSON value into a <see cref="T:System.Text.Json.Nodes.JsonNode" />. The stream will be read to completion.</summary>
|
||||
@@ -2788,7 +2960,8 @@ There is remaining data in the stream.</exception>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||||
<exception cref="T:System.Text.Json.JsonException">
|
||||
<paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
|
||||
<returns>A <see cref="T:System.Threading.Tasks.Task" /> to produce a <see cref="T:System.Text.Json.Nodes.JsonNode" /> representation of the JSON value.</returns>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A <see cref="T:System.Threading.Tasks.Task" /> to produce either a <see cref="T:System.Text.Json.Nodes.JsonNode" /> representation of the JSON value, or null if the input represents the null JSON value.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonNode.ReplaceWith``1(``0)">
|
||||
<summary>Replaces this node with a new value.</summary>
|
||||
@@ -2796,9 +2969,9 @@ There is remaining data in the stream.</exception>
|
||||
<typeparam name="T">The type of value to be replaced.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonNode.ToJsonString(System.Text.Json.JsonSerializerOptions)">
|
||||
<summary>Converts the current instance to string in JSON format.</summary>
|
||||
<summary>Converts the current instance to a string in JSON format.</summary>
|
||||
<param name="options">Options to control the serialization behavior.</param>
|
||||
<returns>JSON representation of current instance.</returns>
|
||||
<returns>The JSON representation of the current instance.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonNode.ToString">
|
||||
<summary>Gets a string representation for the current value appropriate to the node type.</summary>
|
||||
@@ -2887,10 +3060,35 @@ There is remaining data in the stream.</exception>
|
||||
<param name="options">Options to control the behavior.</param>
|
||||
<returns>The new instance of the <see cref="T:System.Text.Json.Nodes.JsonObject" /> class that contains properties from the specified <see cref="T:System.Text.Json.JsonElement" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonObject.GetAt(System.Int32)">
|
||||
<summary>Gets the property of the specified index.</summary>
|
||||
<param name="index">The zero-based index of the pair to get.</param>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="index" /> is less than 0 or greater than or equal to <see cref="P:System.Text.Json.Nodes.JsonObject.Count" />.</exception>
|
||||
<returns>The property at the specified index as a key/value pair.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonObject.GetEnumerator">
|
||||
<summary>Returns an enumerator that iterates through the <see cref="T:System.Text.Json.Nodes.JsonObject" />.</summary>
|
||||
<returns>An enumerator that iterates through the <see cref="T:System.Text.Json.Nodes.JsonObject" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonObject.IndexOf(System.String)">
|
||||
<summary>Determines the index of a specific property name in the object.</summary>
|
||||
<param name="propertyName">The property name to locate.</param>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="propertyName" /> is <see langword="null" />.</exception>
|
||||
<returns>The index of <paramref name="propertyName" /> if found; otherwise, -1.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonObject.Insert(System.Int32,System.String,System.Text.Json.Nodes.JsonNode)">
|
||||
<summary>Inserts a property into the object at the specified index.</summary>
|
||||
<param name="index">The zero-based index at which the property should be inserted.</param>
|
||||
<param name="propertyName">The property name to insert.</param>
|
||||
<param name="value">The JSON value to insert.</param>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="propertyName" /> is <see langword="null" />.</exception>
|
||||
<exception cref="T:System.ArgumentException">An element with the same key already exists in the <see cref="T:System.Text.Json.Nodes.JsonObject" />.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="index" /> is less than 0 or greater than <see cref="P:System.Text.Json.Nodes.JsonObject.Count" />.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonObject.Remove(System.String)">
|
||||
<summary>Removes the element with the specified property name from the <see cref="T:System.Text.Json.Nodes.JsonObject" />.</summary>
|
||||
<param name="propertyName">The property name of the element to remove.</param>
|
||||
@@ -2899,6 +3097,33 @@ There is remaining data in the stream.</exception>
|
||||
<returns>
|
||||
<see langword="true" /> if the element is successfully removed; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonObject.RemoveAt(System.Int32)">
|
||||
<summary>Removes the property at the specified index.</summary>
|
||||
<param name="index">The zero-based index of the item to remove.</param>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="index" /> is less than 0 or greater than or equal to <see cref="P:System.Text.Json.Nodes.JsonObject.Count" />.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonObject.SetAt(System.Int32,System.String,System.Text.Json.Nodes.JsonNode)">
|
||||
<summary>Sets a new property at the specified index.</summary>
|
||||
<param name="index">The zero-based index of the property to set.</param>
|
||||
<param name="propertyName">The property name to store at the specified index.</param>
|
||||
<param name="value">The JSON value to store at the specified index.</param>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="index" /> is less than 0 or greater than or equal to <see cref="P:System.Text.Json.Nodes.JsonObject.Count" />.</exception>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
<paramref name="propertyName" /> is already specified in a different index.</exception>
|
||||
<exception cref="T:System.InvalidOperationException">
|
||||
<paramref name="value" /> already has a parent.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonObject.SetAt(System.Int32,System.Text.Json.Nodes.JsonNode)">
|
||||
<summary>Sets a new property value at the specified index.</summary>
|
||||
<param name="index">The zero-based index of the property to set.</param>
|
||||
<param name="value">The JSON value to store at the specified index.</param>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="index" /> is less than 0 or greater than or equal to <see cref="P:System.Text.Json.Nodes.JsonObject.Count" />.</exception>
|
||||
<exception cref="T:System.InvalidOperationException">
|
||||
<paramref name="value" /> already has a parent.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonObject.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#String@System#Text#Json#Nodes#JsonNode}}#Contains(System.Collections.Generic.KeyValuePair{System.String,System.Text.Json.Nodes.JsonNode})">
|
||||
<summary>Determines whether the <see cref="T:System.Text.Json.Nodes.JsonObject" /> contains a specific property name and <see cref="T:System.Text.Json.Nodes.JsonNode" /> reference.</summary>
|
||||
<param name="item">The element to locate in the <see cref="T:System.Text.Json.Nodes.JsonObject" />.</param>
|
||||
@@ -2930,6 +3155,16 @@ There is remaining data in the stream.</exception>
|
||||
<returns>
|
||||
<see langword="true" /> if the <see cref="T:System.Text.Json.Nodes.JsonObject" /> contains an element with the specified property name; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonObject.System#Collections#Generic#IList{System#Collections#Generic#KeyValuePair{System#String@System#Text#Json#Nodes#JsonNode}}#IndexOf(System.Collections.Generic.KeyValuePair{System.String,System.Text.Json.Nodes.JsonNode})">
|
||||
<param name="item" />
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonObject.System#Collections#Generic#IList{System#Collections#Generic#KeyValuePair{System#String@System#Text#Json#Nodes#JsonNode}}#Insert(System.Int32,System.Collections.Generic.KeyValuePair{System.String,System.Text.Json.Nodes.JsonNode})">
|
||||
<param name="index" />
|
||||
<param name="item" />
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonObject.System#Collections#Generic#IList{System#Collections#Generic#KeyValuePair{System#String@System#Text#Json#Nodes#JsonNode}}#RemoveAt(System.Int32)">
|
||||
<param name="index" />
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Nodes.JsonObject.System#Collections#IEnumerable#GetEnumerator">
|
||||
<summary>Returns an enumerator that iterates through the <see cref="T:System.Text.Json.Nodes.JsonObject" />.</summary>
|
||||
<returns>An enumerator that iterates through the <see cref="T:System.Text.Json.Nodes.JsonObject" />.</returns>
|
||||
@@ -2963,6 +3198,9 @@ There is remaining data in the stream.</exception>
|
||||
<summary>Gets a collection containing the property values in the <see cref="T:System.Text.Json.Nodes.JsonObject" />.</summary>
|
||||
<returns>An <see cref="T:System.Collections.Generic.ICollection`1" /> containing the values in the object that implements <see cref="T:System.Collections.Generic.IDictionary`2" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Nodes.JsonObject.System#Collections#Generic#IList{System#Collections#Generic#KeyValuePair{System#String@System#Text#Json#Nodes#JsonNode}}#Item(System.Int32)">
|
||||
<param name="index" />
|
||||
</member>
|
||||
<member name="T:System.Text.Json.Nodes.JsonValue">
|
||||
<summary>Represents a mutable JSON value.</summary>
|
||||
</member>
|
||||
@@ -3198,6 +3436,48 @@ There is remaining data in the stream.</exception>
|
||||
<returns>
|
||||
<see langword="true" /> if the value can be successfully obtained; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="T:System.Text.Json.Schema.JsonSchemaExporter">
|
||||
<summary>Functionality for exporting JSON schema from serialization contracts defined in <see cref="T:System.Text.Json.Serialization.Metadata.JsonTypeInfo" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Schema.JsonSchemaExporter.GetJsonSchemaAsNode(System.Text.Json.JsonSerializerOptions,System.Type,System.Text.Json.Schema.JsonSchemaExporterOptions)">
|
||||
<summary>Gets the JSON schema for <paramref name="type" /> as a <see cref="T:System.Text.Json.Nodes.JsonNode" /> document.</summary>
|
||||
<param name="options">The options declaring the contract for the type.</param>
|
||||
<param name="type">The type for which to resolve a schema.</param>
|
||||
<param name="exporterOptions">The options object governing the export operation.</param>
|
||||
<returns>A JSON object containing the schema for <paramref name="type" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Schema.JsonSchemaExporter.GetJsonSchemaAsNode(System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Text.Json.Schema.JsonSchemaExporterOptions)">
|
||||
<summary>Gets the JSON schema for <paramref name="typeInfo" /> as a <see cref="T:System.Text.Json.Nodes.JsonNode" /> document.</summary>
|
||||
<param name="typeInfo">The contract from which to resolve the JSON schema.</param>
|
||||
<param name="exporterOptions">The options object governing the export operation.</param>
|
||||
<returns>A JSON object containing the schema for <paramref name="typeInfo" />.</returns>
|
||||
</member>
|
||||
<member name="T:System.Text.Json.Schema.JsonSchemaExporterContext">
|
||||
<summary>Defines the context for the generated JSON schema for a particular node in a type graph.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Schema.JsonSchemaExporterContext.BaseTypeInfo" />
|
||||
<member name="P:System.Text.Json.Schema.JsonSchemaExporterContext.Path">
|
||||
<summary>The path to the current node in the generated JSON schema.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Schema.JsonSchemaExporterContext.PropertyInfo">
|
||||
<summary>The <see cref="T:System.Text.Json.Serialization.Metadata.JsonPropertyInfo" /> if the schema is being generated for a property.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Schema.JsonSchemaExporterContext.TypeInfo">
|
||||
<summary>The <see cref="T:System.Text.Json.Serialization.Metadata.JsonTypeInfo" /> for the type being processed.</summary>
|
||||
</member>
|
||||
<member name="T:System.Text.Json.Schema.JsonSchemaExporterOptions">
|
||||
<summary>Configures the behavior of the <see cref="T:System.Text.Json.Schema.JsonSchemaExporter" /> APIs.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Schema.JsonSchemaExporterOptions.#ctor" />
|
||||
<member name="P:System.Text.Json.Schema.JsonSchemaExporterOptions.Default">
|
||||
<summary>Gets the default configuration object used by <see cref="T:System.Text.Json.Schema.JsonSchemaExporter" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Schema.JsonSchemaExporterOptions.TransformSchemaNode">
|
||||
<summary>Defines a callback that is invoked for every schema that is generated within the type graph.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Schema.JsonSchemaExporterOptions.TreatNullObliviousAsNonNullable">
|
||||
<summary>Determines whether non-nullable schemas should be generated for <see langword="null" /> oblivious reference types.</summary>
|
||||
</member>
|
||||
<member name="T:System.Text.Json.Serialization.IJsonOnDeserialized">
|
||||
<summary>Specifies that the JSON type should have its <see cref="M:System.Text.Json.Serialization.IJsonOnDeserialized.OnDeserialized" /> method called after deserialization occurs.</summary>
|
||||
</member>
|
||||
@@ -3328,10 +3608,6 @@ There is remaining data in the stream.</exception>
|
||||
<member name="T:System.Text.Json.Serialization.JsonDerivedTypeAttribute">
|
||||
<summary>When placed on a type declaration, indicates that the specified subtype should be opted into polymorphic serialization.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Serialization.JsonDerivedTypeAttribute.#ctor(System.Type)">
|
||||
<summary>Initializes a new attribute with specified parameters.</summary>
|
||||
<param name="derivedType">A derived type that should be supported in polymorphic serialization of the declared based type.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Serialization.JsonDerivedTypeAttribute.#ctor(System.Type,System.Int32)">
|
||||
<summary>Initializes a new attribute with specified parameters.</summary>
|
||||
<param name="derivedType">A derived type that should be supported in polymorphic serialization of the declared base type.</param>
|
||||
@@ -3342,6 +3618,10 @@ There is remaining data in the stream.</exception>
|
||||
<param name="derivedType">A derived type that should be supported in polymorphic serialization of the declared base type.</param>
|
||||
<param name="typeDiscriminator">The type discriminator identifier to be used for the serialization of the subtype.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Serialization.JsonDerivedTypeAttribute.#ctor(System.Type)">
|
||||
<summary>Initializes a new attribute with specified parameters.</summary>
|
||||
<param name="derivedType">A derived type that should be supported in polymorphic serialization of the declared based type.</param>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.JsonDerivedTypeAttribute.DerivedType">
|
||||
<summary>A derived type that should be supported in polymorphic serialization of the declared base type.</summary>
|
||||
</member>
|
||||
@@ -3380,7 +3660,7 @@ There is remaining data in the stream.</exception>
|
||||
</member>
|
||||
<member name="T:System.Text.Json.Serialization.JsonIncludeAttribute">
|
||||
<summary>Indicates that the member should be included for serialization and deserialization.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The attribute is applied to a non-public property.</exception>
|
||||
<exception cref="T:System.InvalidOperationException">.NET 7 and earlier versions only: The attribute is applied to a non-public property.</exception>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Serialization.JsonIncludeAttribute.#ctor">
|
||||
<summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonIncludeAttribute" />.</summary>
|
||||
@@ -3482,14 +3762,14 @@ There is remaining data in the stream.</exception>
|
||||
<see langword="true" /> to instruct the deserializer to ignore any unrecognized type discriminator IDs and revert to the contract of the base type; <see langword="false" /> to fail the deserialization for unrecognized type discriminator IDs.</returns>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.JsonPolymorphicAttribute.TypeDiscriminatorPropertyName">
|
||||
<summary>Gets or sets a custom type discriminator property name for the polymorhic type.
|
||||
<summary>Gets or sets a custom type discriminator property name for the polymorphic type.
|
||||
Uses the default '$type' property name if left unset.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.JsonPolymorphicAttribute.UnknownDerivedTypeHandling">
|
||||
<summary>Gets or sets the behavior when serializing an undeclared derived runtime type.</summary>
|
||||
</member>
|
||||
<member name="T:System.Text.Json.Serialization.JsonPropertyNameAttribute">
|
||||
<summary>Specifies the property name that is present in the JSON when serializing and deserializing. This overrides any naming policy specified by <see cref="T:System.Text.Json.JsonNamingPolicy" />.</summary>
|
||||
<summary>Specifies the property name that is present in the JSON when serializing and deserializing.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Serialization.JsonPropertyNameAttribute.#ctor(System.String)">
|
||||
<summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonPropertyNameAttribute" /> with the specified property name.</summary>
|
||||
@@ -3578,6 +3858,9 @@ There is remaining data in the stream.</exception>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="defaults" /> is invalid.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute.AllowOutOfOrderMetadataProperties">
|
||||
<summary>Specifies the default value of <see cref="P:System.Text.Json.JsonSerializerOptions.AllowOutOfOrderMetadataProperties" /> when set.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute.AllowTrailingCommas">
|
||||
<summary>Gets or sets the default value of <see cref="P:System.Text.Json.JsonSerializerOptions.AllowTrailingCommas" />.</summary>
|
||||
</member>
|
||||
@@ -3605,9 +3888,18 @@ There is remaining data in the stream.</exception>
|
||||
<member name="P:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute.IncludeFields">
|
||||
<summary>Gets or sets a value that indicates whether to include fields for serialization and deserialization.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute.IndentCharacter">
|
||||
<summary>Specifies the default value of <see cref="P:System.Text.Json.JsonSerializerOptions.IndentCharacter" /> when set.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute.IndentSize">
|
||||
<summary>Specifies the default value of <see cref="P:System.Text.Json.JsonSerializerOptions.IndentCharacter" /> when set.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute.MaxDepth">
|
||||
<summary>Gets or sets the default value of <see cref="P:System.Text.Json.JsonSerializerOptions.MaxDepth" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute.NewLine">
|
||||
<summary>Specifies the default value of <see cref="P:System.Text.Json.JsonSerializerOptions.NewLine" /> when set.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute.NumberHandling">
|
||||
<summary>Gets or sets the default value of <see cref="P:System.Text.Json.JsonSerializerOptions.NumberHandling" />.</summary>
|
||||
</member>
|
||||
@@ -3623,6 +3915,12 @@ There is remaining data in the stream.</exception>
|
||||
<member name="P:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute.ReadCommentHandling">
|
||||
<summary>Gets or sets the default value of <see cref="P:System.Text.Json.JsonSerializerOptions.ReadCommentHandling" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute.RespectNullableAnnotations">
|
||||
<summary>Specifies the default value of <see cref="P:System.Text.Json.JsonSerializerOptions.RespectNullableAnnotations" /> when set.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute.RespectRequiredConstructorParameters">
|
||||
<summary>Specifies the default value of <see cref="P:System.Text.Json.JsonSerializerOptions.RespectRequiredConstructorParameters" /> when set.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute.UnknownTypeHandling">
|
||||
<summary>Gets or sets the default value of <see cref="P:System.Text.Json.JsonSerializerOptions.UnknownTypeHandling" />.</summary>
|
||||
</member>
|
||||
@@ -3684,6 +3982,11 @@ There is remaining data in the stream.</exception>
|
||||
<param name="options">The serialization options to use.</param>
|
||||
<returns>A converter for which <code data-dev-comment-type="typeparamref">T</code> is compatible with <code data-dev-comment-type="paramref">typeToConvert</code>.</returns>
|
||||
</member>
|
||||
<member name="T:System.Text.Json.Serialization.JsonStringEnumMemberNameAttribute" />
|
||||
<member name="M:System.Text.Json.Serialization.JsonStringEnumMemberNameAttribute.#ctor(System.String)">
|
||||
<param name="name" />
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.JsonStringEnumMemberNameAttribute.Name" />
|
||||
<member name="T:System.Text.Json.Serialization.JsonUnknownDerivedTypeHandling">
|
||||
<summary>Defines how objects of a derived runtime type that has not been explicitly declared for polymorphic serialization should be handled.</summary>
|
||||
</member>
|
||||
@@ -3774,10 +4077,6 @@ There is remaining data in the stream.</exception>
|
||||
<member name="T:System.Text.Json.Serialization.Metadata.JsonDerivedType">
|
||||
<summary>Represents a supported derived type defined in the metadata of a polymorphic type.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Serialization.Metadata.JsonDerivedType.#ctor(System.Type)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Serialization.Metadata.JsonDerivedType" /> class that represents a supported derived type without a type discriminator.</summary>
|
||||
<param name="derivedType">The derived type to be supported by the polymorphic type metadata.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Serialization.Metadata.JsonDerivedType.#ctor(System.Type,System.Int32)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Serialization.Metadata.JsonDerivedType" /> class that represents a supported derived type with an integer type discriminator.</summary>
|
||||
<param name="derivedType">The derived type to be supported by the polymorphic type metadata.</param>
|
||||
@@ -3788,6 +4087,10 @@ There is remaining data in the stream.</exception>
|
||||
<param name="derivedType">The derived type to be supported by the polymorphic type metadata.</param>
|
||||
<param name="typeDiscriminator">The type discriminator to be associated with the derived type.</param>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Serialization.Metadata.JsonDerivedType.#ctor(System.Type)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Serialization.Metadata.JsonDerivedType" /> class that represents a supported derived type without a type discriminator.</summary>
|
||||
<param name="derivedType">The derived type to be supported by the polymorphic type metadata.</param>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonDerivedType.DerivedType">
|
||||
<summary>Gets a derived type that should be supported in polymorphic serialization of the declared base type.</summary>
|
||||
</member>
|
||||
@@ -4138,6 +4441,9 @@ There is remaining data in the stream.</exception>
|
||||
<typeparam name="T">The object type to serialize or deserialize.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Serialization.Metadata.JsonObjectInfoValues`1.#ctor" />
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonObjectInfoValues`1.ConstructorAttributeProviderFactory">
|
||||
<summary>Provides a delayed attribute provider corresponding to the deserialization constructor.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonObjectInfoValues`1.ConstructorParameterMetadataInitializer">
|
||||
<summary>Provides a mechanism to initialize metadata for a parameterized constructor of the class or struct to be used when deserializing.</summary>
|
||||
</member>
|
||||
@@ -4156,6 +4462,36 @@ There is remaining data in the stream.</exception>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonObjectInfoValues`1.SerializeHandler">
|
||||
<summary>Gets or sets a serialization implementation for instances of the class or struct that assumes options specified by <see cref="T:System.Text.Json.Serialization.JsonSourceGenerationOptionsAttribute" />.</summary>
|
||||
</member>
|
||||
<member name="T:System.Text.Json.Serialization.Metadata.JsonParameterInfo">
|
||||
<summary>Provides JSON serialization-related metadata about a constructor parameter.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonParameterInfo.AttributeProvider">
|
||||
<summary>Gets a custom attribute provider for the current parameter.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonParameterInfo.DeclaringType">
|
||||
<summary>Gets the declaring type of the constructor.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonParameterInfo.DefaultValue">
|
||||
<summary>Gets a value indicating the default value if the parameter has a default value.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonParameterInfo.HasDefaultValue">
|
||||
<summary>Gets a value indicating whether the parameter has a default value.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonParameterInfo.IsMemberInitializer">
|
||||
<summary>Gets a value indicating whether the parameter represents a required or init-only member initializer.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonParameterInfo.IsNullable">
|
||||
<summary>Gets a value indicating whether the constructor parameter is annotated as nullable.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonParameterInfo.Name">
|
||||
<summary>Gets the name of the parameter.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonParameterInfo.ParameterType">
|
||||
<summary>Gets the type of this parameter.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonParameterInfo.Position">
|
||||
<summary>Gets the zero-based position of the parameter in the formal parameter list.</summary>
|
||||
</member>
|
||||
<member name="T:System.Text.Json.Serialization.Metadata.JsonParameterInfoValues">
|
||||
<summary>Provides information about a constructor parameter required for JSON deserialization.</summary>
|
||||
</member>
|
||||
@@ -4166,6 +4502,12 @@ There is remaining data in the stream.</exception>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonParameterInfoValues.HasDefaultValue">
|
||||
<summary>Gets or sets a value that specifies whether a default value was specified for the parameter.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonParameterInfoValues.IsMemberInitializer">
|
||||
<summary>Whether the parameter represents a required or init-only member initializer.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonParameterInfoValues.IsNullable">
|
||||
<summary>Whether the parameter allows <see langword="null" /> values.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonParameterInfoValues.Name">
|
||||
<summary>Gets or sets the name of the parameter.</summary>
|
||||
</member>
|
||||
@@ -4202,6 +4544,9 @@ There is remaining data in the stream.</exception>
|
||||
<member name="T:System.Text.Json.Serialization.Metadata.JsonPropertyInfo">
|
||||
<summary>Provides JSON serialization-related metadata about a property or field.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.AssociatedParameter">
|
||||
<summary>Gets the constructor parameter associated with the current property.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.AttributeProvider">
|
||||
<summary>Gets or sets the custom attribute provider for the current property.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Text.Json.Serialization.Metadata.JsonPropertyInfo" /> instance has been locked for further modification.</exception>
|
||||
@@ -4210,6 +4555,9 @@ There is remaining data in the stream.</exception>
|
||||
<summary>Gets or sets a custom converter override for the current property.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Text.Json.Serialization.Metadata.JsonPropertyInfo" /> instance has been locked for further modification.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.DeclaringType">
|
||||
<summary>Gets the declaring type of the property.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.Get">
|
||||
<summary>Gets or sets a getter delegate for the property.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Text.Json.Serialization.Metadata.JsonPropertyInfo" /> instance has been locked for further modification.</exception>
|
||||
@@ -4222,10 +4570,26 @@ There is remaining data in the stream.</exception>
|
||||
|
||||
The current <see cref="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.PropertyType" /> is not valid for use with extension data.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.IsGetNullable">
|
||||
<summary>Gets or sets a value indicating whether the return type of the getter is annotated as nullable.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">
|
||||
<para>The <see cref="T:System.Text.Json.Serialization.Metadata.JsonPropertyInfo" /> instance has been locked for further modification.</para>
|
||||
<para>-or-</para>
|
||||
<para>The current <see cref="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.PropertyType" /> is not a reference type or <see cref="T:System.Nullable`1" />.</para>
|
||||
</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.IsRequired">
|
||||
<summary>Gets or sets a value that indicates whether the current property is required for deserialization to be successful.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Text.Json.Serialization.Metadata.JsonPropertyInfo" /> instance has been locked for further modification.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.IsSetNullable">
|
||||
<summary>Gets or sets a value indicating whether the input type of the setter is annotated as nullable.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">
|
||||
<para>The <see cref="T:System.Text.Json.Serialization.Metadata.JsonPropertyInfo" /> instance has been locked for further modification.</para>
|
||||
<para>-or-</para>
|
||||
<para>The current <see cref="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.PropertyType" /> is not a reference type or <see cref="T:System.Nullable`1" />.</para>
|
||||
</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.Name">
|
||||
<summary>Gets or sets the JSON property name used when serializing the property.</summary>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
@@ -4262,6 +4626,9 @@ The current <see cref="P:System.Text.Json.Serialization.Metadata.JsonPropertyInf
|
||||
<typeparam name="T">The type to convert of the <see cref="T:System.Text.Json.Serialization.JsonConverter`1" /> for the property.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Serialization.Metadata.JsonPropertyInfoValues`1.#ctor" />
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfoValues`1.AttributeProviderFactory">
|
||||
<summary>Provides a <see cref="T:System.Reflection.ICustomAttributeProvider" /> factory that maps to <see cref="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.AttributeProvider" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfoValues`1.Converter">
|
||||
<summary>A <see cref="T:System.Text.Json.Serialization.JsonConverter" /> for the property or field, specified by <see cref="T:System.Text.Json.Serialization.JsonConverterAttribute" />.</summary>
|
||||
</member>
|
||||
@@ -4339,6 +4706,10 @@ The current <see cref="P:System.Text.Json.Serialization.Metadata.JsonPropertyInf
|
||||
<member name="M:System.Text.Json.Serialization.Metadata.JsonTypeInfo.MakeReadOnly">
|
||||
<summary>Locks the current instance for further modification.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonTypeInfo.ConstructorAttributeProvider">
|
||||
<summary>Gets or sets an attribute provider corresponding to the deserialization constructor.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Text.Json.Serialization.Metadata.JsonPropertyInfo" /> instance has been locked for further modification.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonTypeInfo.Converter">
|
||||
<summary>Gets the <see cref="T:System.Text.Json.Serialization.JsonConverter" /> associated with the current type.</summary>
|
||||
</member>
|
||||
@@ -4350,9 +4721,15 @@ The current <see cref="P:System.Text.Json.Serialization.Metadata.JsonPropertyInf
|
||||
|
||||
A parameterless factory is not supported for the current metadata <see cref="P:System.Text.Json.Serialization.Metadata.JsonTypeInfo.Kind" />.</exception>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonTypeInfo.ElementType">
|
||||
<summary>Gets the element type corresponding to an enumerable, dictionary or optional type.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonTypeInfo.IsReadOnly">
|
||||
<summary>Gets a value that indicates whether the current instance has been locked for modification.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonTypeInfo.KeyType">
|
||||
<summary>Gets the key type corresponding to a dictionary type.</summary>
|
||||
</member>
|
||||
<member name="P:System.Text.Json.Serialization.Metadata.JsonTypeInfo.Kind">
|
||||
<summary>Gets a value that describes the kind of contract metadata that the current instance specifies.</summary>
|
||||
</member>
|
||||
@@ -4467,6 +4844,11 @@ A parameterless factory is not supported for the current metadata <see cref="P:S
|
||||
<member name="T:System.Text.Json.Serialization.Metadata.JsonTypeInfoResolver">
|
||||
<summary>Contains utilities and combinators acting on <see cref="T:System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Serialization.Metadata.JsonTypeInfoResolver.Combine(System.ReadOnlySpan{System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver})">
|
||||
<summary>Combines multiple <see cref="T:System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver" /> sources into one.</summary>
|
||||
<param name="resolvers">Sequence of contract resolvers to be queried for metadata.</param>
|
||||
<returns>A <see cref="T:System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver" /> combining results from <paramref name="resolvers" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Serialization.Metadata.JsonTypeInfoResolver.Combine(System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver[])">
|
||||
<summary>Combines multiple <see cref="T:System.Text.Json.Serialization.Metadata.IJsonTypeInfoResolver" /> sources into one.</summary>
|
||||
<param name="resolvers">Sequence of contract resolvers to be queried for metadata.</param>
|
||||
@@ -4984,6 +5366,7 @@ The current depth exceeds the recursive limit set by the maximum depth.</excepti
|
||||
<summary>Asynchronously commits the JSON text written so far, which makes it visible to the output destination.</summary>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
||||
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
|
||||
<returns>A task representing the asynchronous flush operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.Text.Json.Utf8JsonWriter.Reset">
|
||||
|
||||
Reference in New Issue
Block a user