WithSort¶

interface WithSort<Document : Any> : Options

Describes in which order elements should be returned by the query.

Properties¶

abstract val allOptions: List<Option>

The full list of options set on this container.

abstract val context:

The context used to generate this expression.

abstract override fun accept(node: BsonNode)

Adds a new node as a child of this one.

fun <N : Node> CompoundNode<N>.acceptAll(nodes: Iterable<N>)

Adds any number of nodes into this one.

abstract override fun freeze()

Makes this expression immutable.

inline fun <O : Option> Options.option(): O?

Accesses the value of a given Option.

abstract fun simplify(): BsonNode?

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

open fun sort(block: SortOptionDsl<Document>.() -> Unit)

The order in which documents should be returned.

open fun toBson():

Writes the result of simplifying to a new Bson.

abstract override fun toString(): String

JSON representation of this option.

abstract fun writeTo(writer: )

Writes the result of simplifying this expression into writer.