Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class ReusableStringReader

    Internal class to enable reuse of the string reader by GetTokenStream(string, string)

    Inheritance
    object
    MarshalByRefObject
    TextReader
    ReusableStringReader
    Implements
    IDisposable
    Inherited Members
    TextReader.Null
    TextReader.Close()
    TextReader.Dispose()
    TextReader.Peek()
    TextReader.Read(Span<char>)
    TextReader.ReadAsync(char[], int, int)
    TextReader.ReadAsync(Memory<char>, CancellationToken)
    TextReader.ReadBlock(char[], int, int)
    TextReader.ReadBlock(Span<char>)
    TextReader.ReadBlockAsync(char[], int, int)
    TextReader.ReadBlockAsync(Memory<char>, CancellationToken)
    TextReader.ReadLine()
    TextReader.ReadLineAsync()
    TextReader.ReadLineAsync(CancellationToken)
    TextReader.ReadToEndAsync()
    TextReader.ReadToEndAsync(CancellationToken)
    TextReader.Synchronized(TextReader)
    MarshalByRefObject.GetLifetimeService()
    MarshalByRefObject.InitializeLifetimeService()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Analysis
    Assembly: Lucene.Net.dll
    Syntax
    public sealed class ReusableStringReader : TextReader, IDisposable

    Methods

    Dispose(bool)

    Releases the unmanaged resources used by the TextReader and optionally releases the managed resources.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing

    true to release both managed and unmanaged resources; false to release only unmanaged resources.

    Overrides
    TextReader.Dispose(bool)

    Read()

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

    Declaration
    public override int Read()
    Returns
    Type Description
    int

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

    Overrides
    TextReader.Read()
    Exceptions
    Type Condition
    ObjectDisposedException

    The TextReader is closed.

    IOException

    An I/O error occurs.

    Read(char[], int, int)

    Reads a specified maximum number of characters from the current reader and writes the data to a buffer, beginning at the specified index.

    Declaration
    public override int Read(char[] c, int off, int len)
    Parameters
    Type Name Description
    char[] c
    int off
    int len
    Returns
    Type Description
    int

    The number of characters that have been read. The number will be less than or equal to count, depending on whether the data is available within the reader. This method returns 0 (zero) if it is called when no more characters are left to read.

    Overrides
    TextReader.Read(char[], int, int)
    Exceptions
    Type Condition
    ArgumentNullException

    buffer is null.

    ArgumentException

    The buffer length minus index is less than count.

    ArgumentOutOfRangeException

    index or count is negative.

    ObjectDisposedException

    The TextReader is closed.

    IOException

    An I/O error occurs.

    ReadToEnd()

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

    Declaration
    public override string ReadToEnd()
    Returns
    Type Description
    string

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

    Overrides
    TextReader.ReadToEnd()
    Exceptions
    Type Condition
    IOException

    An I/O error occurs.

    ObjectDisposedException

    The TextReader is closed.

    OutOfMemoryException

    There is insufficient memory to allocate a buffer for the returned string.

    ArgumentOutOfRangeException

    The number of characters in the next line is larger than Int32.MaxValue

    Implements

    IDisposable
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.