Class StreamReader

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

Hierarchy (view full)

Constructors

constructor

Methods

Cast Equals GetHashCode ReadLine ReadToEnd ToString TryCast Equals

Constructors

constructor

  • new StreamReader(stream): StreamReader

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

    Parameters

    • stream: Stream

      The stream to be read.

    Returns StreamReader

  • new StreamReader(stream, detectEncodingFromByteOrderMarks): 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

  • new StreamReader(stream, encoding): 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

  • new StreamReader(stream, encoding, detectEncodingFromByteOrderMarks): 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

Cast

  • Cast<T1, T2>(this, type): T1

  • 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

Equals

  • Equals(obj): boolean

  • 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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ReadLine

  • ReadLine(): string

  • 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.

ReadToEnd

  • ReadToEnd(): string

  • 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.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • 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

StaticEquals

  • Equals(objA, objB): boolean

  • 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.

Settings

Member Visibility

On This Page

Constructors
Methods