NamespaceSystemLibrary.Common.Net.Extensions SystemLibrary.Common.Net.dll

Extensions for streams like reading content as json directly into class through JsonAsync()

StreamExtensions

public static class StreamExtensions

Inheritance

System.Object

StreamExtensions

Examples

Arguments

X

Methods

Reading a Stream async as JsonData converting it into a class T

Used for instance when you read the content of a HttpResponse and directly converting it into T instead of storing as string first

public static async Task<T> JsonAsync<T>(this Stream stream, JsonSerializerOptions options = null, CancellationToken cancellationToken = default(CancellationToken))

X

using (var contentStream = await response.Content.ReadAsStreamAsync().ConfigureAwait(false))
   return await contentStream.JsonAsync<T>(jsonSerializerOptions).ConfigureAwait(false);

X

Generic types

Name	Description
T

Methods arguments

Type	Name	Description
System.IO.Stream	stream
System.Text.Json.JsonSerializerOptions	options
System.Threading.CancellationToken	cancellationToken

X

Type	Description
System.Threading.Tasks.Task<T>	T or default

Reads a stream and hashing its content as MD5

Remarks

X

If data is larger than ~200 bytes then .ToSha1Hash() is faster

public static string ToMD5Hash(this Stream stream)

X

var fileStream = new FileStream(@"C:\file.txt", FileMode.Open);
var hash = fileStream.ToMD5Hash();

X

Methods arguments

Type	Name	Description
System.IO.Stream	stream

X

Type	Description
System.String	Md5 hash or null if unreadable stream

Reads a stream and hashing its content as MD5

Remarks

X

If data is larger than ~200 bytes then .ToSha1Hash() is faster

public static async Task<string> ToMD5HashAsync(this Stream stream)

X

var fileStream = new FileStream(@"C:\file.txt", FileMode.Open);
var hash = fileStream.ToMD5HashAsync().Result;

X

Methods arguments

Type	Name	Description
System.IO.Stream	stream

X

Type	Description
System.Threading.Tasks.Task<System.String>	Md5 hash or null if unreadable stream

Reads a stream and hashing its content as Sha1

Remarks

X

If data is smaller than ~200 bytes then .ToMD5Hash() is faster

public static string ToSha1Hash(this Stream stream)

X

var fileStream = new FileStream(@"C:\file.txt", FileMode.Open);
var hash = fileStream.ToSha1Hash();

X

Methods arguments

Type	Name	Description
System.IO.Stream	stream

X

Type	Description
System.String	Sha1 hash or null if unreadable stream

Reads a stream and hashing its content as Sha1

Remarks

X

If data is smaller than ~200 bytes then .ToMD5Hash() is faster

public static async Task<string> ToSha1HashAsync(this Stream stream)

X

var fileStream = new FileStream(@"C:\file.txt", FileMode.Open);
var hash = fileStream.ToSha1HashAsync().Result;

X

Methods arguments

Type	Name	Description
System.IO.Stream	stream

X

Type	Description
System.Threading.Tasks.Task<System.String>	Sha1 hash or null if unreadable stream

Reads a stream and hashing its content as Sha256

public static string ToSha256Hash(this Stream stream)

X

var fileStream = new FileStream(@"C:\file.txt", FileMode.Open);
var hash = fileStream.ToSha256Hash();

X

Methods arguments

Type	Name	Description
System.IO.Stream	stream

X

Type	Description
System.String	Sha256 hash or null if unreadable stream

Reads a stream and hashing its content as Sha256

public static async Task<string> ToSha256HashAsync(this Stream stream)

X

var fileStream = new FileStream(@"C:\file.txt", FileMode.Open);
var hash = fileStream.ToSha256HashAsync().Result;

X

Methods arguments

Type	Name	Description
System.IO.Stream	stream

X

Type	Description
System.Threading.Tasks.Task<System.String>	Sha256 hash or null if unreadable stream

}