ToEncodedString Method

Definition

Namespace: Cuemon.Extensions.IO

Assemblies: Cuemon.Extensions.IO.dll

Source: src/Cuemon.Extensions.IO/StreamExtensions.cs

ToEncodedString(Stream, Action<StreamEncodingOptions>)

Converts the specified value to a string.

public static string ToEncodedString(this Stream value, Action<StreamEncodingOptions> setup = null)

Parameters

value Stream: The Stream to extend.
setup Action<StreamEncodingOptions>: The StreamReaderOptions which may be configured.

Returns

string: A string containing the result of the specified value.

Remarks

IEncodingOptions will be initialized with DefaultPreambleSequence and DefaultEncoding.

Exceptions

ArgumentNullException: value cannot be null.
InvalidEnumArgumentException: setup was initialized with an invalid Preamble.

Edit this page