core/org.gnit.lucenekmp.store/IOContext

IOContext

class IOContext(context: IOContext.Context, mergeInfo: MergeInfo?, flushInfo: FlushInfo?, val readAdvice: ReadAdvice)

IOContext holds additional details on the merge/search context. An IOContext object can never be passed as a null parameter to either or

Parameters

context

An object of a enumerator Context type

mergeInfo

must be given when context == MERGE

flushInfo

must be given when context == FLUSH

readAdvice

Advice regarding the read access pattern

Constructors

constructor(context: IOContext.Context, mergeInfo: MergeInfo?, flushInfo: FlushInfo?, readAdvice: ReadAdvice)

constructor(flushInfo: FlushInfo?)

Creates an IOContext for flushing.

constructor(mergeInfo: MergeInfo?)

Creates an IOContext for merging.

Types

object Companion

enum Context : Enum<IOContext.Context>

Context is an enumerator which specifies the context in which the Directory is being used.

Properties

val context: IOContext.Context

val flushInfo: FlushInfo?

val mergeInfo: MergeInfo?

val readAdvice: ReadAdvice

Functions

fun withReadAdvice(advice: ReadAdvice): IOContext

Return an updated IOContext that has the provided ReadAdvice if the [ ] is a Context.DEFAULT context, otherwise return this existing instance. This helps preserve a ReadAdvice.SEQUENTIAL advice for merging, which is always the right choice, while allowing IndexInputs open for searching to use arbitrary [ ]s.