specs2
API
Generated with
specs2/org.specs2/org.specs2.specification/Forms

Forms

org.specs2.specification.Forms
See theForms companion trait
object Forms extends Forms

Attributes

Companion
trait
Graph
Supertypes
trait Forms
trait PropSyntax
trait FormDsl
trait FragmentsDsl
trait ActionDsl
trait TagDsl
class Object
trait Matchable
class Any
Show all
Self type
Forms.type

Members list

Type members

Inherited classlikes

trait ToFragments[T]

Attributes

Inherited from:
FragmentsDsl
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ToSpecStructure[T1, T2]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
Known subtypes
Show all
implicit class appendFragments[T1, T2](t1: T1)(using evidence$1: ToFragments[T1], evidence$2: ToFragments[T2])

Attributes

Inherited from:
FragmentsDsl
Supertypes
class Object
trait Matchable
class Any
implicit class appendSpecStructure[T1, T2](t1: T1)(using tss: ToSpecStructure[T1, T2])

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
implicit class decorate[T <: DecoratedProperty[T]](d: T)

Attributes

Inherited from:
DecoratedProperties (hidden)
Supertypes
class Object
trait Matchable
class Any
object given_Conversion_Effect_EffectCell extends Conversion[Effect[_], EffectCell]

a Effect can be added on a Form row as a EffectCell

a Effect can be added on a Form row as a EffectCell

Attributes

Inherited from:
FormsBuilder (hidden)
Supertypes
class Conversion[Effect[_], EffectCell]
trait (Effect[_]) => EffectCell
class Object
trait Matchable
class Any
object given_Conversion_Form_Result extends Conversion[Form, Result]

a Form can be implicitly executed if necessary

a Form can be implicitly executed if necessary

Attributes

Inherited from:
FormsBuilder (hidden)
Supertypes
class Conversion[Form, Result]
trait Form => Result
class Object
trait Matchable
class Any
object given_Conversion_Fragment_SpecStructure extends Conversion[Fragment, SpecStructure]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Conversion[Fragment, SpecStructure]
class Object
trait Matchable
class Any
object given_Conversion_Fragments_Interpolated extends Conversion[Fragments, Interpolated]

Attributes

Inherited from:
S2StringContext
Supertypes
class Conversion[Fragments, Interpolated]
class Object
trait Matchable
class Any
object given_Conversion_SpecHeader_SpecStructure extends Conversion[SpecHeader, SpecStructure]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Conversion[SpecHeader, SpecStructure]
class Object
trait Matchable
class Any
object given_Conversion_SpecStructure_Fragments extends Conversion[SpecStructure, Fragments]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Conversion[SpecStructure, Fragments]
class Object
trait Matchable
class Any
object given_Conversion_SpecStructure_Interpolated extends Conversion[SpecStructure, Interpolated]

Attributes

Inherited from:
S2StringContext
Supertypes
class Conversion[SpecStructure, Interpolated]
class Object
trait Matchable
class Any
object given_Conversion_SpecificationRef_Interpolated extends Conversion[SpecificationRef, Interpolated]

Attributes

Inherited from:
S2StringContext
Supertypes
class Conversion[SpecificationRef, Interpolated]
class Object
trait Matchable
class Any
object given_Conversion_SpecificationStructure_Interpolated extends Conversion[SpecificationStructure, Interpolated]

Attributes

Inherited from:
S2StringContext
Supertypes
class Object
trait Matchable
class Any
object given_Conversion_String_SpecStructure extends Conversion[String, SpecStructure]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Conversion[String, SpecStructure]
trait String => SpecStructure
class Object
trait Matchable
class Any
object given_ToFragments_Fragment extends ToFragments[Fragment]

Attributes

Inherited from:
FragmentsDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToFragments_Fragments extends ToFragments[Fragments]

Attributes

Inherited from:
FragmentsDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToFragments_Seq extends ToFragments[Seq[Fragment]]

Attributes

Inherited from:
FragmentsDsl
Supertypes
trait ToFragments[Seq[Fragment]]
class Object
trait Matchable
class Any
object given_ToFragments_String extends ToFragments[String]

Attributes

Inherited from:
FragmentsDsl
Supertypes
trait ToFragments[String]
class Object
trait Matchable
class Any
object given_ToSpecStructure_Arguments_Arguments extends ToSpecStructure[Arguments, Arguments]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_Arguments_Fragment extends ToSpecStructure[Arguments, Fragment]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_Arguments_Fragments extends ToSpecStructure[Arguments, Fragments]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_Arguments_SpecHeader extends ToSpecStructure[Arguments, SpecHeader]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_Arguments_SpecStructure extends ToSpecStructure[Arguments, SpecStructure]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_Arguments_String extends ToSpecStructure[Arguments, String]

APPENDING TO ARGUMENTS

APPENDING TO ARGUMENTS

Attributes

Inherited from:
SpecStructureDsl
Supertypes
trait ToSpecStructure[Arguments, String]
class Object
trait Matchable
class Any
object given_ToSpecStructure_Fragment_Arguments extends ToSpecStructure[Fragment, Arguments]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_Fragment_Fragment extends ToSpecStructure[Fragment, Fragment]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_Fragment_Fragments extends ToSpecStructure[Fragment, Fragments]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_Fragment_SpecStructure extends ToSpecStructure[Fragment, SpecStructure]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_Fragment_String extends ToSpecStructure[Fragment, String]

APPENDING TO A FRAGMENT

APPENDING TO A FRAGMENT

Attributes

Inherited from:
SpecStructureDsl
Supertypes
trait ToSpecStructure[Fragment, String]
class Object
trait Matchable
class Any
object given_ToSpecStructure_Fragments_Fragment extends ToSpecStructure[Fragments, Fragment]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_Fragments_Fragments extends ToSpecStructure[Fragments, Fragments]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_Fragments_String extends ToSpecStructure[Fragments, String]

APPENDING TO FRAGMENTS

APPENDING TO FRAGMENTS

Attributes

Inherited from:
SpecStructureDsl
Supertypes
trait ToSpecStructure[Fragments, String]
class Object
trait Matchable
class Any
object given_ToSpecStructure_SpecHeader_Arguments extends ToSpecStructure[SpecHeader, Arguments]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_SpecHeader_Fragment extends ToSpecStructure[SpecHeader, Fragment]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_SpecHeader_Fragments extends ToSpecStructure[SpecHeader, Fragments]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_SpecHeader_Seq extends ToSpecStructure[SpecHeader, Seq[Fragment]]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_SpecHeader_SpecStructure extends ToSpecStructure[SpecHeader, SpecStructure]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_SpecHeader_String extends ToSpecStructure[SpecHeader, String]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
trait ToSpecStructure[SpecHeader, String]
class Object
trait Matchable
class Any
object given_ToSpecStructure_SpecStructure_Arguments extends ToSpecStructure[SpecStructure, Arguments]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_SpecStructure_Fragment extends ToSpecStructure[SpecStructure, Fragment]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_SpecStructure_Fragments extends ToSpecStructure[SpecStructure, Fragments]

APPENDING TO A SPEC STRUCTURE

APPENDING TO A SPEC STRUCTURE

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_SpecStructure_Seq extends ToSpecStructure[SpecStructure, Seq[Fragment]]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_SpecStructure_SpecStructure extends ToSpecStructure[SpecStructure, SpecStructure]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_SpecStructure_String extends ToSpecStructure[SpecStructure, String]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
object given_ToSpecStructure_String_Fragment extends ToSpecStructure[String, Fragment]

APPENDING TO A STRING

APPENDING TO A STRING

Attributes

Inherited from:
SpecStructureDsl
Supertypes
trait ToSpecStructure[String, Fragment]
class Object
trait Matchable
class Any
object given_ToSpecStructure_String_Fragments extends ToSpecStructure[String, Fragments]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
trait ToSpecStructure[String, Fragments]
class Object
trait Matchable
class Any
object given_ToSpecStructure_String_SpecStructure extends ToSpecStructure[String, SpecStructure]

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any

Value members

Inherited methods

def action[T](a: => T)(using evidence$1: AsExecution[T]): Fragment

Attributes

Inherited from:
ActionDsl
def action[T](label: String, a: => T): Prop[T, T]

Attributes

Returns

a new Prop with a label, which has the same actual and expected value to test the result of an action

Inherited from:
FormsBuilder (hidden)
def effect[T](label: String, value: => T): Effect[T]

Attributes

Returns

a new Effect with a label and a value

Inherited from:
FormsBuilder (hidden)
def field(label: String, value1: Field[_], values: Field[_]*): Field[String]

Attributes

Returns

a new Field with a label and several values

Inherited from:
FormsBuilder (hidden)
def field[T](label: String, value: => T): Field[T]

Attributes

Returns

a new Field with a label and a value

Inherited from:
FormsBuilder (hidden)
def field[T](value: => T): Field[T]

Attributes

Returns

a new Field with no label and a value

Inherited from:
FormsBuilder (hidden)
def form(title: String): Form

Attributes

Returns

a new Form with the given title

Inherited from:
FormsBuilder (hidden)
protected def formFragmentFactory: FormFragmentFactory

Attributes

Inherited from:
FormFragmentsFactory
protected def fragmentFactory: FragmentFactory

Attributes

Inherited from:
FragmentsFactory
def fragmentsBlock(fragments: Seq[Fragment], offset: Int): Fragments

create a block of new fragments where each of them is separated by a newline and there is a specific offset from the left margin

create a block of new fragments where each of them is separated by a newline and there is a specific offset from the left margin

Attributes

Inherited from:
FragmentsDsl
def lazify(c: => Cell): LazyCell

a cell can be added lazily to a row. It will only be evaluated when necessary

a cell can be added lazily to a row. It will only be evaluated when necessary

Attributes

Inherited from:
FormsBuilder (hidden)
def postProcessS2Fragments(fs: Fragments): Fragments

this function is exposed so that it can be overridden with side-effects when using s2 strings in mutable specs

this function is exposed so that it can be overridden with side-effects when using s2 strings in mutable specs

Attributes

Inherited from:
S2StringContextCreation
def prop[T, S](label: String, actual: => T, expected: => S, c: Matcher[T]): Prop[T, S]

Attributes

Returns

a new Prop with a label, an actual value and a matcher to apply to the actual value

Inherited from:
FormsBuilder (hidden)
def prop[T](actual: => T, c: Matcher[T]): Prop[T, T]

Attributes

Returns

a new Prop with no label, an actual value and a matcher to apply to the actual value

Inherited from:
FormsBuilder (hidden)
def prop[T](label: String, actual: => T, c: Matcher[T]): Prop[T, T]

Attributes

Returns

a new Prop with a label, an actual value and a matcher to apply to the actual value

Inherited from:
FormsBuilder (hidden)
def prop[T, S](label: String, actual: => T, c: S => Matcher[T]): Prop[T, S]

Attributes

Returns

a new Prop with a label, an actual value and a matcher to apply to values

Inherited from:
FormsBuilder (hidden)
def prop[T, S, R](label: String, actual: => T, c: (T, S) => R)(using evidence$1: AsResult[R]): Prop[T, S]

Attributes

Returns

a new Prop with a label, an actual value and a constraint to apply to values

Inherited from:
FormsBuilder (hidden)
def prop[T, S](label: String, actual: => T, exp: => S): Prop[T, S]

Attributes

Returns

a new Prop with a label, an actual value and expected value

Inherited from:
FormsBuilder (hidden)
def prop[T](label: String, actual: => T): Prop[T, T]

Attributes

Returns

a new Prop with a label and an actual value only

Inherited from:
FormsBuilder (hidden)
def prop[T](act: => T): Prop[T, T]

Attributes

Returns

a new Prop with an actual value only

Inherited from:
FormsBuilder (hidden)
def section(tag: NamedTag): Fragment

Attributes

Inherited from:
TagDsl
def section(names: String*): Fragment

Attributes

Inherited from:
TagDsl
def see(s: => SpecificationStructure): Fragment

Attributes

Inherited from:
ReferenceCreation
def see(s: SpecStructure): Fragment

Attributes

Inherited from:
ReferenceCreation
def step[T](a: => T, global: Boolean)(using evidence$1: AsExecution[T]): Fragment

Attributes

Inherited from:
ActionDsl
def step[T](a: => T)(using evidence$1: AsExecution[T]): Fragment

Attributes

Inherited from:
ActionDsl
def tab(label: String, form: Form): Tabs

Attributes

Returns

a new Tabs object with a first tab

Inherited from:
FormsBuilder (hidden)
def tabs: Tabs

Attributes

Returns

a new Tabs object

Inherited from:
FormsBuilder (hidden)
def tag(tag: NamedTag): Fragment

Attributes

Inherited from:
TagDsl
def tag(names: String*): Fragment

Attributes

Inherited from:
TagDsl

Givens

Inherited givens

given appendFormToString[T](using evidence$1: HasForm[T]): appendFormToString[T]

Attributes

Inherited from:
FormDsl
given given_Conversion_Effect_EffectCell: given_Conversion_Effect_EffectCell

a Effect can be added on a Form row as a EffectCell

a Effect can be added on a Form row as a EffectCell

Attributes

Inherited from:
FormsBuilder (hidden)
given given_Conversion_Field_FieldCell[T]: given_Conversion_Field_FieldCell[T]

a Field can be added on a Form row as a FieldCell

a Field can be added on a Form row as a FieldCell

Attributes

Inherited from:
FormsBuilder (hidden)
given given_Conversion_Form_Result: given_Conversion_Form_Result

a Form can be implicitly executed if necessary

a Form can be implicitly executed if necessary

Attributes

Inherited from:
FormsBuilder (hidden)
given given_Conversion_Prop_PropCell[T, S]: given_Conversion_Prop_PropCell[T, S]

a Prop can be added on a Form row as a PropCell

a Prop can be added on a Form row as a PropCell

Attributes

Inherited from:
FormsBuilder (hidden)
given given_Conversion_Seq_Seq[T](using evidence$1: ToCell[T]): given_Conversion_Seq_Seq[T]

any seq of object convertible to cells

any seq of object convertible to cells

Attributes

Inherited from:
FormsBuilder (hidden)
given given_Conversion_T_Interpolated[T](using evidence$1: HasForm[T]): given_Conversion_T_Interpolated[T]

Attributes

Inherited from:
FormS2StringContext
given given_FragmentFactory: FragmentFactory

The FragmentFactory has to be passed as an implicit in order to be inlined in macros

The FragmentFactory has to be passed as an implicit in order to be inlined in macros

Attributes

Inherited from:
S2StringContextCreation
given given_ToFragments_Seq: given_ToFragments_Seq

Attributes

Inherited from:
FragmentsDsl
given given_ToFragments_T[T](using evidence$1: HasForm[T]): given_ToFragments_T[T]

Attributes

Inherited from:
FormDsl
given given_ToSpecStructure_Arguments_String: given_ToSpecStructure_Arguments_String

APPENDING TO ARGUMENTS

APPENDING TO ARGUMENTS

Attributes

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_Arguments_T[T <: SpecificationStructure]: given_ToSpecStructure_Arguments_T[T]

Attributes

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_Fragment_String: given_ToSpecStructure_Fragment_String

APPENDING TO A FRAGMENT

APPENDING TO A FRAGMENT

Attributes

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_Fragment_T[T <: SpecificationStructure]: given_ToSpecStructure_Fragment_T[T]

Attributes

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_Fragments_String: given_ToSpecStructure_Fragments_String

APPENDING TO FRAGMENTS

APPENDING TO FRAGMENTS

Attributes

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_SpecHeader_T[T <: SpecificationStructure]: given_ToSpecStructure_SpecHeader_T[T]

APPENDING TO A SPEC HEADER

APPENDING TO A SPEC HEADER

Attributes

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_SpecStructure_Fragments: given_ToSpecStructure_SpecStructure_Fragments

APPENDING TO A SPEC STRUCTURE

APPENDING TO A SPEC STRUCTURE

Attributes

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_SpecStructure_T[T <: SpecificationStructure]: given_ToSpecStructure_SpecStructure_T[T]

Attributes

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_String_Fragment: given_ToSpecStructure_String_Fragment

APPENDING TO A STRING

APPENDING TO A STRING

Attributes

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_String_T[T <: SpecificationStructure]: given_ToSpecStructure_String_T[T]

Attributes

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_T_T2[T, T2](using evidence$1: HasForm[T], x$1: ToSpecStructure[T2, Fragment]): given_ToSpecStructure_T_T2[T, T2]

Attributes

Inherited from:
FormDsl

Extensions

Inherited extensions

extension (fragment: Fragment)
def hide: Fragment

Attributes

Inherited from:
FragmentsDsl
extension (fragment: Fragment)
def mute: Fragment

Attributes

Inherited from:
FragmentsDsl
extension [T, R](p: Prop[T, T])(using evidence$1: AsResult[R])
def checkWith(f: T => R): Prop[T, T]

check the actual value with a function

check the actual value with a function

Attributes

Inherited from:
PropSyntax
extension [T](p: Prop[T, T])
infix def must(m: Matcher[T]): Prop[T, T]

check the actual value with a matcher

check the actual value with a matcher

Attributes

Inherited from:
PropSyntax
extension (sc: StringContext)(using factory: FragmentFactory)
inline def s2(inline variables: Interpolated*): Fragments

String interpolation for specs2 fragments

String interpolation for specs2 fragments

Attributes

Inherited from:
S2StringContextCreation
extension [T1, T2](t1: T1)
def ^(t2: => T2)(using tss: ToSpecStructure[T1, T2]): SpecStructure

Attributes

Inherited from:
SpecStructureDsl

Implicits

Inherited implicits

implicit def anyIsField[T](t: => T): Field[T]

anything can be added on a Form row as a Field

anything can be added on a Form row as a Field

Attributes

Inherited from:
FormsBuilderLowPriorityImplicits
implicit def anyIsFieldCell(t: => Any): FieldCell

anything can be added on a Form row as a TextCell

anything can be added on a Form row as a TextCell

Attributes

Inherited from:
FormsBuilderLowPriorityImplicits
final implicit def appendFragments[T1, T2](t1: T1)(using evidence$1: ToFragments[T1], evidence$2: ToFragments[T2]): appendFragments[T1, T2]

Attributes

Inherited from:
FragmentsDsl
final implicit def appendSpecStructure[T1, T2](t1: T1)(using tss: ToSpecStructure[T1, T2]): appendSpecStructure[T1, T2]

Attributes

Inherited from:
SpecStructureDsl
implicit inline def asExecutionIsInterpolated[R](inline r: => R)(using evidence$1: AsExecution[R], inline factory: FragmentFactory): Interpolated

create an example based on an execution

create an example based on an execution

Attributes

Inherited from:
S2StringContext
implicit inline def asResultIsInterpolated[R](inline r: => R)(using evidence$1: AsResult[R]): Interpolated

Attributes

Inherited from:
S2StringContext1 (hidden)
final implicit def decorate[T <: DecoratedProperty[LazyRef(...)]](d: T): decorate[T]

Attributes

Inherited from:
DecoratedProperties (hidden)
implicit def formIsCell(t: => Form): FormCell

a Form can be added on a Form row as a FormCell

a Form can be added on a Form row as a FormCell

Attributes

Inherited from:
FormsBuilderLowPriorityImplicits
implicit def formIsInterpolated(f: => Form): Interpolated

Attributes

Inherited from:
FormS2StringContext
implicit inline def fragmentIsInterpolated(inline f: => Fragment): Interpolated

Attributes

Inherited from:
S2StringContext1 (hidden)
implicit def fragmentsAsSpecStructure(fs: => Fragments): SpecStructure

Attributes

Inherited from:
SpecStructureDsl
implicit def resultAsSpecStructure[R](r: => R)(using evidence$1: AsResult[R]): SpecStructure

Attributes

Inherited from:
SpecStructureDsl
implicit inline def stepParserIsInterpolatedFragment[R](f: StepParser[R])(using evidence$1: AsResult[R]): Interpolated

Attributes

Inherited from:
S2StringContext1 (hidden)
implicit def stringIsInterpolated(s: => String): Interpolated

Attributes

Inherited from:
S2StringContext
implicit inline def stringResultIsInterpolated[R](inline f: String => R)(using evidence$1: AsResult[R]): Interpolated

Attributes

Inherited from:
S2StringContext1 (hidden)
implicit def xmlIsACell(xml: => NodeSeq): XmlCell

any xml can be injected as a cell

any xml can be injected as a cell

Attributes

Inherited from:
FormsBuilderLowPriorityImplicits
Generated with