Class DumpableStream

Namespace

Ecng.Common

Assembly

Ecng.Common.dll

Represents a stream wrapper that records all data read from and written to the underlying stream.

public class DumpableStream : Stream, IDisposable, IAsyncDisposable

Inheritance

object

MarshalByRefObject

Stream

DumpableStream

Implements

IDisposable

IAsyncDisposable

Inherited Members

Stream.Null

Stream.CopyTo(Stream)

Stream.CopyTo(Stream, int)

Stream.CopyToAsync(Stream)

Stream.CopyToAsync(Stream, int)

Stream.CopyToAsync(Stream, CancellationToken)

Stream.CopyToAsync(Stream, int, CancellationToken)

Stream.Dispose()

Stream.Close()

Stream.Dispose(bool)

Stream.DisposeAsync()

Stream.FlushAsync()

Stream.FlushAsync(CancellationToken)

Stream.CreateWaitHandle()

Stream.BeginRead(byte[], int, int, AsyncCallback, object)

Stream.EndRead(IAsyncResult)

Stream.ReadAsync(byte[], int, int)

Stream.ReadAsync(byte[], int, int, CancellationToken)

Stream.ReadAsync(Memory<byte>, CancellationToken)

Stream.BeginWrite(byte[], int, int, AsyncCallback, object)

Stream.EndWrite(IAsyncResult)

Stream.WriteAsync(byte[], int, int)

Stream.WriteAsync(byte[], int, int, CancellationToken)

Stream.WriteAsync(ReadOnlyMemory<byte>, CancellationToken)

Stream.Read(Span<byte>)

Stream.ReadByte()

Stream.Write(ReadOnlySpan<byte>)

Stream.WriteByte(byte)

Stream.Synchronized(Stream)

Stream.ObjectInvariant()

Stream.ValidateBufferArguments(byte[], int, int)

Stream.ValidateCopyToArguments(Stream, int)

Stream.CanTimeout

Stream.ReadTimeout

Stream.WriteTimeout

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.MemberwiseClone(bool)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

AsyncHelper.FromResult<TValue>(TValue)

AsyncHelper.ToCompleteSource<TValue>(TValue)

CompareHelper.IsDefault<T>(T)

CompareHelper.IsRuntimeDefault<T>(T)

Converter.TypedTo<TFrom, TTo>(TFrom)

DelegateHelper.AddDelegate<TDelegate>(TDelegate, TDelegate)

DelegateHelper.GetInvocationList<TDelegate>(TDelegate)

DelegateHelper.RemoveAllDelegates<TDelegate>(TDelegate)

DelegateHelper.RemoveDelegate<TDelegate>(TDelegate, TDelegate)

DisposableHelper.MakeDisposable<T>(T, Action<T>)

Enumerator.IsDefined<T>(T)

Enumerator.SplitMask<T>(T)

NullableHelper.Convert<T, TResult>(T, Func<T, TResult>, Func<TResult>)

NullableHelper.IsNull<T>(T)

NullableHelper.IsNull<T>(T, bool)

TupleHelper.ToValues<T>(T)

TypeHelper.CheckOnNull<T>(T, string)

TypeHelper.DoDispose<TSource>(TSource)

TypeHelper.ToScope<T>(T, bool)

NetworkHelper.Format<T>(T, bool)

PersistableHelper.TrySerialize<T>(T, out SettingsStorage)

XamlHelper.CopyToClipboard<T>(T)

Paths.SerializeToString<T>(T, bool)

Paths.Serialize<T>(T, bool)

Paths.Serialize<T>(T, string, bool)

IOHelper.CopySync(Stream, Stream, int)

IOHelper.EnumerateLines(Stream, Encoding, bool)

IOHelper.Read(Stream, Type)

IOHelper.Read(Stream, Type, int)

IOHelper.ReadBuffer(Stream, int)

IOHelper.ReadByteEx(Stream, byte[])

IOHelper.ReadBytes(Stream, byte[], int, int)

IOHelper.ReadInt(Stream, byte[], bool)

IOHelper.ReadLong(Stream, byte[], bool, int)

IOHelper.ReadShort(Stream, byte[], bool)

IOHelper.ReadUInt(Stream, byte[], bool)

IOHelper.ReadULong(Stream, byte[], bool, int)

IOHelper.ReadUShort(Stream, byte[], bool)

IOHelper.Read<T>(Stream)

IOHelper.Save(Stream, string)

IOHelper.WriteByteEx(Stream, byte[], byte)

IOHelper.WriteBytes(Stream, byte[], int, int)

IOHelper.WriteEx(Stream, object)

IOHelper.WriteInt(Stream, byte[], int, bool)

IOHelper.WriteLong(Stream, byte[], long, bool, int)

IOHelper.WriteRaw(Stream, byte[])

IOHelper.WriteRaw(Stream, object)

IOHelper.WriteShort(Stream, byte[], short, bool)

IOHelper.WriteUInt(Stream, byte[], uint, bool)

IOHelper.WriteULong(Stream, byte[], ulong, bool, int)

IOHelper.WriteUShort(Stream, byte[], ushort, bool)

CompareHelper.Compare(object, object)

Converter.To(object, Type)

Converter.To<T>(object)

Enumerator.GetAttributeOfType<TAttribute>(object)

Enumerator.IsEnumBrowsable(object)

Enumerator.SplitMask2(object)

TypeHelper.HasProperty(object, string)

EntityPropertyHelper.GetPropValue(object, string, Func<object, string, object>, IDictionary<string, object>)

Extensions.GetBasicProperties(object, int)

Extensions.GetDisplayName(object)

Extensions.GetFieldDescription(object)

Extensions.GetFieldDisplayName(object)

Extensions.GetFieldIcon(object)

JsonHelper.ToJson(object, bool)

JsonHelper.ToJson(object, bool, JsonSerializerSettings)

PersistableHelper.ToStorage(object, bool)

EditorExtensions.ToItemsSource(object, Type, bool?, ListSortDirection?, Func<IItemsSourceItem, bool>, Func<object, string>, Func<object, string>)

XamlHelper.EnsureUIThread(object)

XamlHelper.ShowModel<TWindow>(object, DependencyObject)

XamlHelper.WpfCast<T>(object)

VirtualPropertyRegistry.TryGetVirtualValue(object, string, out object)

Constructors

DumpableStream(Stream)

Represents a stream wrapper that records all data read from and written to the underlying stream.

public DumpableStream(Stream underlying)

Parameters

underlying Stream

The underlying stream to wrap.

Properties

CanRead

Gets a value indicating whether the current stream supports reading.

public override bool CanRead { get; }

Property Value

bool

CanSeek

Gets a value indicating whether the current stream supports seeking.

public override bool CanSeek { get; }

Property Value

bool

CanWrite

Gets a value indicating whether the current stream supports writing.

public override bool CanWrite { get; }

Property Value

bool

Length

Gets the length in bytes of the stream.

public override long Length { get; }

Property Value

long

Exceptions

NotSupportedException

A class derived from Stream does not support seeking.

ObjectDisposedException

Methods were called after the stream was closed.

Position

Gets or sets the position within the current stream.

public override long Position { get; set; }

Property Value

long

Exceptions

IOException

An I/O error occurs.

NotSupportedException

The stream does not support seeking.

ObjectDisposedException

Methods were called after the stream was closed.

ReadDump

Gets the allocation array that collects data read from the underlying stream.

public AllocationArray<byte> ReadDump { get; }

Property Value

AllocationArray<byte>

WriteDump

Gets the allocation array that collects data written to the underlying stream.

public AllocationArray<byte> WriteDump { get; }

Property Value

AllocationArray<byte>

Methods

Flush()

When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.

public override void Flush()

Exceptions

IOException

An I/O error occurs.

GetReadDump()

Retrieves and clears the dump of data read from the underlying stream.

public byte[] GetReadDump()

Returns

byte[]

A byte array containing the dumped read data.

GetWriteDump()

Retrieves and clears the dump of data written to the underlying stream.

public byte[] GetWriteDump()

Returns

byte[]

A byte array containing the dumped write data.

Read(byte[], int, int)

Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

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

Parameters

buffer byte[]

An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.

offset int

The zero-based byte offset in buffer at which to begin storing the data read from the current stream.

count int

The maximum number of bytes to be read from the current stream.

Returns

int

The total number of bytes read into the buffer.

Exceptions

ArgumentException

The sum of offset and count is larger than the buffer length.

ArgumentNullException

buffer is null.

ArgumentOutOfRangeException

offset or count is negative.

IOException

An I/O error occurs.

NotSupportedException

The stream does not support reading.

ObjectDisposedException

Methods were called after the stream was closed.

Seek(long, SeekOrigin)

When overridden in a derived class, sets the position within the current stream.

public override long Seek(long offset, SeekOrigin origin)

Parameters

offset long

A byte offset relative to the origin parameter.

origin SeekOrigin

A value of type SeekOrigin indicating the reference point used to obtain the new position.

Returns

long

The new position within the current stream.

Exceptions

IOException

An I/O error occurs.

NotSupportedException

The stream does not support seeking.

ObjectDisposedException

Methods were called after the stream was closed.

SetLength(long)

When overridden in a derived class, sets the length of the current stream.

public override void SetLength(long value)

Parameters

value long

The desired length of the current stream in bytes.

Exceptions

IOException

An I/O error occurs.

NotSupportedException

The stream does not support both writing and seeking.

ObjectDisposedException

Methods were called after the stream was closed.

Write(byte[], int, int)

Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

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

Parameters

buffer byte[]

An array of bytes. This method copies count bytes from buffer to the current stream.

offset int

The zero-based byte offset in buffer at which to begin copying bytes to the current stream.

count int

The number of bytes to be written to the current stream.