Class StreamDecoratorExtensions

Extension methods for the System.IO.Stream class hidden behind the IDecorator<T> interface.

public static class StreamDecoratorExtensions

Methods

Converts the enclosed System.IO.Stream of the specified decorator to an System.Xml.XmlReader.

public static XmlReader ToXmlReader(this IDecorator<Stream> decorator, Encoding encoding = null, Action<XmlReaderSettings> setup = null)

decorator IDecorator<Stream>: The IDecorator<T> to extend.
encoding Encoding: The text encoding to use.
setup Action<XmlReaderSettings>: The System.Xml.XmlReaderSettings which may be configured.

XmlReader: An System.Xml.XmlReader representation of the enclosed System.IO.Stream of the specified decorator.

If encoding is null, an System.Text.Encoding object will be attempted resolved by TryDetectXmlEncoding(IDecorator<Stream>, out Encoding).

Tries to resolve the System.Text.Encoding level of the XML document from the enclosed System.IO.Stream of the specified decorator.

public static bool TryDetectXmlEncoding(this IDecorator<Stream> decorator, out Encoding result)

decorator IDecorator<Stream>: The IDecorator<T> to extend.
result Encoding: When this method returns, it contains the System.Text.Encoding value equivalent to the encoding level of the XML document contained in the enclosed System.IO.Stream of the specified decorator, if the conversion succeeded, or a null reference if the conversion failed. The conversion fails if the enclosed System.IO.Stream of the specified decorator is null, does not contain BOM information or does not contain an System.Xml.XmlDeclaration.

Boolean: true if the enclosed System.IO.Stream of the specified decorator was converted successfully; otherwise, false.