Class FSDirectory.FSIndexOutput

Writes output with Write(byte[], int, int)

Inheritance
object
DataOutput
IndexOutput
BufferedIndexOutput
FSDirectory.FSIndexOutput
Implements
Inherited Members
Namespace: Lucene.Net.Store
Assembly: Lucene.Net.dll
Syntax
protected class FSDirectory.FSIndexOutput : BufferedIndexOutput, IDisposable

Constructors

FSIndexOutput(FSDirectory, string)

Writes output with Write(byte[], int, int)

Declaration
public FSIndexOutput(FSDirectory parent, string name)
Parameters
Type Name Description
FSDirectory parent
string name

Properties

Checksum

Returns the current checksum of bytes written so far

Declaration
public override long Checksum { get; }
Property Value
Type Description
long
Overrides

Length

Gets or Sets the file length. By default, this property's setter does nothing (it's optional for a Directory to implement it). But, certain Directory implementations (for example FSDirectory) can use this to inform the underlying IO system to pre-allocate the file to the specified size. If the length is longer than the current file length, the bytes added to the file are undefined. Otherwise the file is truncated.

Declaration
public override long Length { get; }
Property Value
Type Description
long
Overrides

Position

Returns the current position in this file, where the next write will occur.

This was getFilePointer() in Lucene.
Declaration
public override long Position { get; }
Property Value
Type Description
long
Overrides
See Also

Methods

Dispose(bool)

Closes this stream to further operations.

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

Flush()

Forces any buffered output to be written.

Declaration
public override void Flush()
Overrides

FlushBuffer(byte[], int, int)

Expert: implements buffer write. Writes bytes at the current position in the output.

Declaration
protected override void FlushBuffer(byte[] b, int offset, int size)
Parameters
Type Name Description
byte[] b

the bytes to write
int offset

the offset in the byte array
int size
Overrides

Seek(long)

Random-access methods

Declaration
[Obsolete("(4.1) this method will be removed in Lucene 5.0")]
public override void Seek(long pos)
Parameters
Type Name Description
long pos
Overrides

WriteByte(byte)

Writes a single byte.

The most primitive data type is an eight-bit byte. Files are accessed as sequences of bytes. All other data types are defined as sequences of bytes, so file formats are byte-order independent.
Declaration
public override void WriteByte(byte b)
Parameters
Type Name Description
byte b
Overrides
See Also

WriteBytes(byte[], int, int)

Writes an array of bytes.

Declaration
public override void WriteBytes(byte[] b, int offset, int length)
Parameters
Type Name Description
byte[] b

the bytes to write
int offset

the offset in the byte array
int length

the number of bytes to write
Overrides
See Also

Implements