Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | Protected Member Functions | Properties | List of all members
Lucene.Net.Store.ChecksumIndexInput Class Reference

Writes bytes through to a primary IndexOutput, computing checksum as it goes. Note that you cannot use seek(). More...

Inherits Lucene.Net.Store.IndexInput.

Public Member Functions

 ChecksumIndexInput (IndexInput main)
 
override byte ReadByte ()
 Reads and returns a single byte.
 
override void ReadBytes (byte[] b, int offset, int len)
 Reads a specified number of bytes into an array at the specified offset.
 
override void Seek (long pos)
 Sets current position in this file, where the next read will occur.
 
override long Length ()
 The number of bytes in the file.
 
- Public Member Functions inherited from Lucene.Net.Store.IndexInput
virtual void ReadBytes (byte[] b, int offset, int len, bool useBuffer)
 Reads a specified number of bytes into an array at the specified offset with control over whether the read should be buffered (callers who have their own buffer should pass in "false" for useBuffer). Currently only BufferedIndexInput respects this parameter.
 
virtual int ReadInt ()
 Reads four bytes and returns an int.
 
virtual int ReadVInt ()
 Reads an int stored in variable-length format. Reads between one and five bytes. Smaller values take fewer bytes. Negative numbers are not supported.
 
virtual long ReadLong ()
 Reads eight bytes and returns a long.
 
virtual long ReadVLong ()
 Reads a long stored in variable-length format. Reads between one and nine bytes. Smaller values take fewer bytes. Negative numbers are not supported.
 
virtual void SetModifiedUTF8StringsMode ()
 Call this if readString should read characters stored in the old modified UTF8 format (length in java chars and java's modified UTF8 encoding). This is used for indices written pre-2.4 See LUCENE-510 for details.
 
virtual System.String ReadString ()
 Reads a string.
 
virtual void ReadChars (char[] buffer, int start, int length)
 Reads Lucene's old "modified UTF-8" encoded characters into an array.
 
virtual void SkipChars (int length)
 Expert
 
void Close ()
 
void Dispose ()
 Closes the stream to futher operations.
 
virtual System.Object Clone ()
 Returns a clone of this stream.
 
virtual
System.Collections.Generic.IDictionary
< string, string > 
ReadStringStringMap ()
 

Protected Member Functions

override void Dispose (bool disposing)
 

Properties

virtual long Checksum [get]
 
override long FilePointer [get]
 
- Properties inherited from Lucene.Net.Store.IndexInput
abstract long FilePointer [get]
 Returns the current position in this file, where the next read will occur.
 

Detailed Description

Writes bytes through to a primary IndexOutput, computing checksum as it goes. Note that you cannot use seek().

Definition at line 27 of file CheckSumIndexInput.cs.

Constructor & Destructor Documentation

Lucene.Net.Store.ChecksumIndexInput.ChecksumIndexInput ( IndexInput  main)

Definition at line 34 of file CheckSumIndexInput.cs.

Member Function Documentation

override void Lucene.Net.Store.ChecksumIndexInput.Dispose ( bool  disposing)
protectedvirtual

Implements Lucene.Net.Store.IndexInput.

Definition at line 58 of file CheckSumIndexInput.cs.

override long Lucene.Net.Store.ChecksumIndexInput.Length ( )
virtual

The number of bytes in the file.

Implements Lucene.Net.Store.IndexInput.

Definition at line 84 of file CheckSumIndexInput.cs.

override byte Lucene.Net.Store.ChecksumIndexInput.ReadByte ( )
virtual

Reads and returns a single byte.

See Also
IndexOutput.WriteByte(byte)

Implements Lucene.Net.Store.IndexInput.

Definition at line 40 of file CheckSumIndexInput.cs.

override void Lucene.Net.Store.ChecksumIndexInput.ReadBytes ( byte[]  b,
int  offset,
int  len 
)
virtual

Reads a specified number of bytes into an array at the specified offset.

Parameters
bthe array to read bytes into
offsetthe offset in the array to start storing bytes
lenthe number of bytes to read
See Also
IndexOutput.WriteBytes(byte[],int)

Implements Lucene.Net.Store.IndexInput.

Definition at line 47 of file CheckSumIndexInput.cs.

override void Lucene.Net.Store.ChecksumIndexInput.Seek ( long  pos)
virtual

Sets current position in this file, where the next read will occur.

See Also
FilePointer

Implements Lucene.Net.Store.IndexInput.

Definition at line 79 of file CheckSumIndexInput.cs.

Property Documentation

virtual long Lucene.Net.Store.ChecksumIndexInput.Checksum
get

Definition at line 54 of file CheckSumIndexInput.cs.

override long Lucene.Net.Store.ChecksumIndexInput.FilePointer
get

Definition at line 75 of file CheckSumIndexInput.cs.


The documentation for this class was generated from the following file: