MediaTypeFormatter.ReadFromStreamAsync Method
Asynchronously deserializes an object of the specified type.
Namespace: System.Net.Http.Formatting
Assembly: System.Net.Http.Formatting (in System.Net.Http.Formatting.dll)
Syntax
'Declaration
Public Overridable Function ReadFromStreamAsync ( _
type As Type, _
readStream As Stream, _
content As HttpContent, _
formatterLogger As IFormatterLogger _
) As Task(Of Object)
'Usage
Dim instance As MediaTypeFormatter
Dim type As Type
Dim readStream As Stream
Dim content As HttpContent
Dim formatterLogger As IFormatterLogger
Dim returnValue As Task(Of Object)
returnValue = instance.ReadFromStreamAsync(type, _
readStream, content, formatterLogger)
public virtual Task<Object> ReadFromStreamAsync(
Type type,
Stream readStream,
HttpContent content,
IFormatterLogger formatterLogger
)
public:
virtual Task<Object^>^ ReadFromStreamAsync(
Type^ type,
Stream^ readStream,
HttpContent^ content,
IFormatterLogger^ formatterLogger
)
abstract ReadFromStreamAsync :
type:Type *
readStream:Stream *
content:HttpContent *
formatterLogger:IFormatterLogger -> Task<Object>
override ReadFromStreamAsync :
type:Type *
readStream:Stream *
content:HttpContent *
formatterLogger:IFormatterLogger -> Task<Object>
public function ReadFromStreamAsync(
type : Type,
readStream : Stream,
content : HttpContent,
formatterLogger : IFormatterLogger
) : Task<Object>
Parameters
type
Type: System.TypeThe type of the object to deserialize.
readStream
Type: System.IO.StreamThe Stream to read.
content
Type: HttpContentThe HttpContent, if available. It may be null.
formatterLogger
Type: System.Net.Http.Formatting.IFormatterLoggerThe IFormatterLogger to log events to.
Return Value
Type: System.Threading.Tasks.Task<Object>
A Task whose result will be an object of the given type.
Exceptions
| Exception | Condition |
|---|---|
| NotSupportedException | Derived types need to support reading. |
Remarks
This implementation throws a NotSupportedException. Derived types should override this method if the formatter supports reading. An implementation of this method should not close readStream upon completion. The stream will be closed independently when the HttpContent instance is disposed.