kmp-jsonpointer/com.commonsware.json.pointer/RelativePointerResult

RelativePointerResult

sealed interface RelativePointerResult(source)

The result of applying a Relative JSON Pointer (see JsonPointer.plus).

Inheritors

Pointer

Index

Key

Types

Index

class Index(val index: Int) : RelativePointerResult

The relative pointer ended with # and the resolved location is (or appears to be) an array element. The index is the zero-based position of that element within its parent array.

Key

class Key(val key: String) : RelativePointerResult

The relative pointer ended with # and the resolved location is an object member. The key is the name of that member within its parent object.

Pointer

class Pointer(val pointer: JsonPointer) : RelativePointerResult

The relative pointer navigated to a specific location within the document.