Action
    Preparing search index...

    Class StreamReader

    Implements a System.IO.TextReader that reads characters from a byte stream in a particular encoding.

    Hierarchy (View Summary)

    Index

    Constructors

    • Initializes a new instance of the System.IO.StreamReader class for the specified stream.

      Parameters

      • stream: Stream

        The stream to be read.

      Returns StreamReader

    • Initializes a new instance of the System.IO.StreamReader class for the specified stream, with the specified byte order mark detection option.

      Parameters

      • stream: Stream

        The stream to be read.

      • detectEncodingFromByteOrderMarks: boolean | Boolean

        Indicates whether to look for byte order marks at the beginning of the file.

      Returns StreamReader

    • Initializes a new instance of the System.IO.StreamReader class for the specified stream, with the specified character encoding.

      Parameters

      • stream: Stream

        The stream to be read.

      • encoding: Encoding

        The character encoding to use.

      Returns StreamReader

    • Initializes a new instance of the System.IO.StreamReader class for the specified stream, with the specified character encoding and byte order mark detection option.

      Parameters

      • stream: Stream

        The stream to be read.

      • encoding: Encoding

        The character encoding to use.

      • detectEncodingFromByteOrderMarks: boolean | Boolean

        Indicates whether to look for byte order marks at the beginning of the file.

      Returns StreamReader

    Methods

    • Casts this object to the specified type. Throws error on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1

    • Determines whether the specified object is equal to the current object.

      Parameters

      • obj: any

        The object to compare with the current object.

      Returns boolean

      true if the specified object is equal to the current object; otherwise, false.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Reads the next character without changing the state of the reader or the character source. Returns the next available character without actually reading it from the reader.

      Returns number

      An integer representing the next character to be read, or -1 if no more characters are available or the reader does not support seeking.

    • Reads the next character from the text reader and advances the character position by one character.

      Returns number

      The next character from the text reader, or -1 if no more characters are available. The default implementation returns -1.

    • Reads a line of characters from the text reader and returns the data as a string.

      Returns string

      The next line from the reader, or null if all characters have been read.

    • Reads all characters from the current position to the end of the text reader and returns them as one string.

      Returns string

      A string that contains all characters from the current position to the end of the text reader.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • Casts this object to the specified type. Returns null on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns null | T1

    • Determines whether the specified object instances are considered equal.

      Parameters

      • objA: any

        The first object to compare.

      • objB: any

        The second object to compare.

      Returns boolean

      true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.