Fragments

case class Fragments(contents: AsyncStream[Fragment])

Fragments of a specification

It is implemented as an async Producer[Fragment] in order to produce fragments dynamically if necessary

Companion
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def append(other: Fragment): Fragments

append one or several fragments

append one or several fragments

def append(others: Seq[Fragment]): Fragments
def append(others: Fragments): Fragments
def append(other: AsyncStream[Fragment]): Fragments
def appendLazy(other: => Fragment): Fragments
def collect[A](predicate: PartialFunction[Fragment, A]): AsyncStream[A]

when 2 Text fragments are contiguous append them together to only make one

when 2 Text fragments are contiguous append them together to only make one

def examples: Action[List[Fragment]]

run the process to filter all examples

run the process to filter all examples

def filter(predicate: Fragment => Boolean): Fragments
def flatMap(f: Fragment => AsyncStream[Fragment]): Fragments
def fragments: Action[List[Fragment]]

run the process to get all fragments

run the process to get all fragments

def fragmentsList(ee: ExecutionEnv): List[Fragment]

run the process to get all fragments as a list

run the process to get all fragments as a list

def linkReferences: AsyncStream[SpecificationRef]

run the process to get all specification link references

run the process to get all specification link references

def mapFragments(f: List[Fragment] => List[Fragment]): Fragments
def markers: Action[List[Fragment]]

run the process to filter all markers

run the process to filter all markers

def prepend(other: Fragment): Fragments

prepend one or several fragments to this process

prepend one or several fragments to this process

def prepend(others: Fragments): Fragments
def prepend(others: Seq[Fragment]): Fragments
def prepend(other: AsyncStream[Fragment]): Fragments
def prependLazy(other: => Fragment): Fragments
def referenced: Action[List[Fragment]]

run the process to get all specification references as Fragments

run the process to get all specification references as Fragments

def seeReferences: AsyncStream[SpecificationRef]

run the process to get all specification see references

run the process to get all specification see references

run the process to get all specification references

run the process to get all specification references

strip the margin of all examples

strip the margin of all examples

def stripMargin(margin: Char): Fragments

strip the margin of all examples

strip the margin of all examples

def tags: Producer[[A] =>> Action[A], NamedTag]

run the process to collect all tags

run the process to collect all tags

def texts: Action[List[Fragment]]

run the process to filter all texts

run the process to filter all texts

def when(condition: => Boolean): Fragments

filter, map or flatMap the fragments

filter, map or flatMap the fragments

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product