api/org.jetbrains.kotlinx.jupyter.api.exceptions/ReplException

ReplException

open class ReplException(message: String, cause: Throwable? = null) : Exception

Base class for all kinds of exceptions that may happen in REPL

Inheritors

ReplMessageOnlyException

Constructors

ReplException

constructor(message: String, cause: Throwable? = null)

Properties

cause

open val cause: Throwable?

customHeader

open val customHeader: String?

If this exception is a cause of runtime failure, this header will be specified after the exception traceback, if not null. If null, the default header will be specified, which is ": "

jupyterException

open val jupyterException: Throwable

Type (in JVM sense) and message of this exception that will end up as ename and evalue in the Jupyter error reply message

message

open val message: String?

traceback

open val traceback: List<String>

Traceback (in the Jupyter sense) of this exception

Functions

getAdditionalInfoJson

open fun getAdditionalInfoJson(): JsonObject?

This JSON may contain some extra metadata for a Jupyter client, i.e., a line of code to highlight as an error's cause

messageAndStackTrace

fun Throwable.messageAndStackTrace(withMessage: Boolean = true): String

render

open fun render(): String?

Sometimes errors should be printed to the error stream instead of being returned as an error reply. I.e., in cases when they appear in the library integration and not in the user code. In such cases this method is called to calculate a string representation of them

renderException

fun Throwable.renderException(): String