quarkdown-core/com.quarkdown.core.ast.base/LinkNode

LinkNode

interface LinkNode : ErrorCapableNode

A general link node. A link can error for various reasons. For example, a com.quarkdown.core.ast.base.inline.SubdocumentLink can error if the linked subdocument cannot be found.

See also

Inheritors

Properties

Link copied to clipboard
abstract var error: Pair<Throwable, PipelineErrorHandler>?

The error that occurred during processing, paired with the PipelineErrorHandler strategy to handle it. If null, no error occurred and the node is rendered normally via acceptOnSuccess.

Link copied to clipboard
abstract val fileSystem: FileSystem?

Optional file system where this link is defined, used for resolving relative paths.

Link copied to clipboard
abstract val label: InlineContent

Inline content of the displayed label.

Link copied to clipboard
abstract val title: InlineContent?

Optional title.

Link copied to clipboard
abstract val url: String

URL this link points to.

Functions

Link copied to clipboard
open override fun <T> accept(visitor: NodeVisitor<T>): T

Accepts the error as a node if an error is present, otherwise accepts this node normally via acceptOnSuccess.

Link copied to clipboard
abstract fun <T> acceptOnSuccess(visitor: NodeVisitor<T>): T

Visits this node with the given visitor when no error is present.

Link copied to clipboard
Link copied to clipboard
fun Node.getStoredMedia(context: Context): StoredMedia?

Retrieves the stored media associated with this node, if any.

Link copied to clipboard
fun ErrorCapableNode.setError(throwable: Throwable, context: Context)

Sets the given throwable as the error of this node, paired with the error handler from context.

Link copied to clipboard
fun LinkNode.setResolvedUrl(context: MutableContext, resolvedUrl: String)

Registers the resolved path of this node within the document handled by context.

Link copied to clipboard