MongoDB request DSL/opensavvy.ktmongo.dsl.options/Options

Options

interface Options : CompoundBsonNode(source)

Parent interface for all option containers.

Option containers are types that declare a set of options. They are usually tied to a specific MongoDB command.

For example, for options related to the Count command, see CountOptions.

Inheritors

Properties

Link copied to clipboard
abstract val allOptions: List<Option>

The full list of options set on this container.

Link copied to clipboard
abstract val context: <Error class: unknown class>

The context used to generate this expression.

Functions

Link copied to clipboard
abstract override fun accept(node: BsonNode)

Adds a new node as a child of this one.

Link copied to clipboard
fun <N : Node> CompoundNode<N>.acceptAll(nodes: Iterable<N>)

Adds any number of nodes into this one.

Link copied to clipboard
abstract override fun freeze()

Makes this expression immutable.

Link copied to clipboard
inline fun <O : Option> Options.option(): O?

Accesses the value of a given Option.

Link copied to clipboard
abstract fun simplify(): BsonNode?

Returns a simplified (but equivalent) expression to the current expression.

Link copied to clipboard
open fun toBson(): <Error class: unknown class>

Writes the result of simplifying to a new Bson.

Link copied to clipboard
abstract override fun toString(): String

JSON representation of this option.

Link copied to clipboard
abstract fun writeTo(writer: <Error class: unknown class>)

Writes the result of simplifying this expression into writer.