AwaitableStream AwaitableStream Class

Definition

Namespace:: Microsoft.Extensions.AwaitableStream Microsoft.Extensions.AwaitableStream

Assembly:: Microsoft.Extensions.AwaitableStream.dll

Edit

Meant to be used with CopyToAsync for bufferless reads

public class AwaitableStream : Stream, IDisposable

Public Class AwaitableStream
    Inherits Stream
    Implements IDisposable

Inheritance: ObjectObject
StreamStream
AwaitableStreamAwaitableStream

Implements: IDisposableIDisposable

Properties

CanRead CanRead

Edit

public override bool CanRead { get; }

Public Overrides ReadOnly Property CanRead As Boolean

Value: Boolean Boolean

Overrides: Stream.CanReadStream.CanRead

CanSeek CanSeek

Edit

public override bool CanSeek { get; }

Public Overrides ReadOnly Property CanSeek As Boolean

Value: Boolean Boolean

Overrides: Stream.CanSeekStream.CanSeek

CanWrite CanWrite

Edit

public override bool CanWrite { get; }

Public Overrides ReadOnly Property CanWrite As Boolean

Value: Boolean Boolean

Overrides: Stream.CanWriteStream.CanWrite

Completion Completion

Edit

public Task Completion { get; }

Public ReadOnly Property Completion As Task

Value: Task Task

Length Length

Edit

public override long Length { get; }

Public Overrides ReadOnly Property Length As Long

Value: Int64 Int64

Overrides: Stream.LengthStream.Length

Position Position

Edit

public override long Position { get; set; }

Public Overrides Property Position As Long

Value: Int64 Int64

Overrides: Stream.PositionStream.Position

Methods

Cancel() Cancel()

Edit

public void Cancel()

Public Sub Cancel

CanTimeout CanTimeout

Inherited from Stream

Consumed(Int32) Consumed(Int32)

Edit

Tell the awaitable stream how many bytes were consumed. This needs to be called from the continuation.

public void Consumed(int count)

Public Sub Consumed(count As Integer)

Parameters

count: Int32 Int32

Number of bytes consumed by the continuation

CopyTo(Stream) CopyTo(Stream)

Inherited from Stream

CopyTo(Stream, Int32) CopyTo(Stream, Int32)

Inherited from Stream

CopyToAsync(Stream) CopyToAsync(Stream)

Inherited from Stream

CopyToAsync(Stream, Int32) CopyToAsync(Stream, Int32)

Inherited from Stream

CopyToAsync(Stream, Int32, CancellationToken) CopyToAsync(Stream, Int32, CancellationToken)

Inherited from Stream

AwaitableStream AwaitableStream

Inherited from Stream

Dispose() Dispose()

Inherited from Stream

Dispose(Boolean) Dispose(Boolean)

Edit

protected override void Dispose(bool disposing)

Protected Overrides Sub Dispose(disposing As Boolean)

Parameters

disposing: Boolean Boolean

Overrides: Stream.Dispose(Boolean)Stream.Dispose(Boolean)

Equals(Object) Equals(Object)

Inherited from Object

Equals(Object, Object) Equals(Object, Object)

Inherited from Object

Flush() Flush()

Edit

public override void Flush()

Public Overrides Sub Flush

Overrides: Stream.Flush()Stream.Flush()

FlushAsync() FlushAsync()

Inherited from Stream

FlushAsync(CancellationToken) FlushAsync(CancellationToken)

Inherited from Stream

GetHashCode() GetHashCode()

Inherited from Object

GetType() GetType()

Inherited from Object

MemberwiseClone() MemberwiseClone()

Inherited from Object

Read(Byte[], Int32, Int32) Read(Byte(), Int32, Int32)

Edit

public override int Read(byte[] buffer, int offset, int count)

Public Overrides Function Read(buffer As Byte(), offset As Integer, count As Integer) As Integer

Parameters

buffer: Byte[] Byte()

offset: Int32 Int32

count: Int32 Int32

Returns

Int32 Int32

Overrides: Stream.Read(Byte[], Int32, Int32)Stream.Read(Byte[], Int32, Int32)

ReadAsync() ReadAsync()

Edit

public StreamAwaitable ReadAsync()

Public Function ReadAsync As StreamAwaitable

Returns

StreamAwaitable StreamAwaitable

ReadAsync(Byte[], Int32, Int32) ReadAsync(Byte(), Int32, Int32)

Inherited from Stream

ReadAsync(Byte[], Int32, Int32, CancellationToken) ReadAsync(Byte(), Int32, Int32, CancellationToken)

Inherited from Stream

ReadByte() ReadByte()

Inherited from Stream

ReadTimeout ReadTimeout

Inherited from Stream

ReferenceEquals(Object, Object) ReferenceEquals(Object, Object)

Inherited from Object

Seek(Int64, SeekOrigin) Seek(Int64, SeekOrigin)

Edit

public override long Seek(long offset, SeekOrigin origin)

Public Overrides Function Seek(offset As Long, origin As SeekOrigin) As Long

Parameters

offset: Int64 Int64

origin: SeekOrigin SeekOrigin

Returns

Int64 Int64

Overrides: Stream.Seek(Int64, SeekOrigin)Stream.Seek(Int64, SeekOrigin)

SetLength(Int64) SetLength(Int64)

Edit

public override void SetLength(long value)

Public Overrides Sub SetLength(value As Long)

Parameters

value: Int64 Int64

Overrides: Stream.SetLength(Int64)Stream.SetLength(Int64)

ToString() ToString()

Inherited from Object

Write(Byte[], Int32, Int32) Write(Byte(), Int32, Int32)

Edit

public override void Write(byte[] buffer, int offset, int count)

Public Overrides Sub Write(buffer As Byte(), offset As Integer, count As Integer)

Parameters

buffer: Byte[] Byte()

offset: Int32 Int32

count: Int32 Int32

Overrides: Stream.Write(Byte[], Int32, Int32)Stream.Write(Byte[], Int32, Int32)

WriteAsync(Byte[], Int32, Int32) WriteAsync(Byte(), Int32, Int32)

Inherited from Stream

WriteAsync(Byte[], Int32, Int32, CancellationToken) WriteAsync(Byte(), Int32, Int32, CancellationToken)

Edit

public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)

Public Overrides Function WriteAsync(buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task

Parameters

buffer: Byte[] Byte()

offset: Int32 Int32

count: Int32 Int32

cancellationToken: CancellationToken CancellationToken

Returns

Task Task

Overrides: Stream.WriteAsync(Byte[], Int32, Int32, CancellationToken)Stream.WriteAsync(Byte[], Int32, Int32, CancellationToken)

WriteByte(Byte) WriteByte(Byte)

Inherited from Stream

WriteTimeout WriteTimeout

Inherited from Stream