quarkdown-core/com.quarkdown.core.function.library.module/QuarkdownModule

QuarkdownModule

class QuarkdownModule(functions: Set<ExportableFunction>) : HashSet<ExportableFunction>

A subsection of Quarkdown functions that can be exported via a MultiFunctionLibraryLoader.

While this class might seem redundant in place of a typealias, having an actual class makes it easier and more robust on Quarkdoc^1's side to identify modules.

^1: Quarkdoc is Quarkdown's documentation generator, based on Dokka. See the quarkdown-quarkdoc module.

Parameters

functions

the functions to export in the module

Constructors

QuarkdownModule

constructor(functions: Set<ExportableFunction>)

constructor(vararg modules: QuarkdownModule)

Creates a QuarkdownModule that wraps multiple QuarkdownModules, joining their functions into a single module. The identity of the submodules is lost in the process.

Properties

isEmpty

open override val isEmpty: Boolean

size

open val size: Int

Functions

add

open fun add(e: ExportableFunction): Boolean

addAll

open fun addAll(c: Collection<out ExportableFunction>): Boolean

clear

open fun clear()

clone

open fun clone(): Any

contains

open operator fun contains(o: ExportableFunction): Boolean

containsAll

open fun containsAll(c: Collection<ExportableFunction>): Boolean

groupify

fun Iterable<NamedRegexPattern>.groupify(): Regex

Groups a sequence of patterns into a single Regex where every capture group is identified by its token type (name). The result is cached so that repeated calls with the same patterns reuse the compiled Regex.

iterator

open operator fun iterator(): MutableIterator<ExportableFunction>

plus

operator fun plus(other: QuarkdownModule): QuarkdownModule

remove

open fun remove(o: ExportableFunction): Boolean

removeAll

open fun removeAll(c: Collection<ExportableFunction>): Boolean

retainAll

open fun retainAll(c: Collection<ExportableFunction>): Boolean

toArray

open fun toArray(): Array<out Any?>?

open fun <T : Any?> toArray(a: Array<out T?>?): Array<out T?>?

wrappedAsValue

fun <T : OutputValue<*>> Set<T>.wrappedAsValue(): UnorderedCollectionValue<T>