RawFormState

class RawFormState[+A]

Interaction state for an explicitly low-level codec-backed event.

raw: The untrusted payload the state was built from.
value: The codec's result: the decoded value or its errors.
used: The browser paths in the payload, minus fields marked _unused_ unless it is a submission.
submitted: Whether the payload is a submission, which makes every field count as used.

Defined by scalive.RawFormState. View source (scalive/api/src/scalive/forms/FormState.scala:107-132)

Methods4

def errors: FormErrors[Any]

Returns the codec errors, or an empty collection on success.

Defined by scalive.RawFormState.errors. View source (scalive/api/src/scalive/forms/FormState.scala:117-117)

def isUsed(name: String): Boolean

Returns whether a field counts as used, which every field does after a submission.

This form parses the browser field name and returns false when it is malformed.

Defined by scalive.RawFormState.isUsed. View source (scalive/api/src/scalive/forms/FormState.scala:132-132)

def isUsed(path: FormPath): Boolean

Returns whether a field counts as used, which every field does after a submission.

This form takes a parsed FormPath.

Defined by scalive.RawFormState.isUsed. View source (scalive/api/src/scalive/forms/FormState.scala:126-126)

def isValid: Boolean

Returns whether the codec decoded the payload.

Defined by scalive.RawFormState.isValid. View source (scalive/api/src/scalive/forms/FormState.scala:114-114)

def valueOption: Option[A]

Returns the decoded value on success.

Defined by scalive.RawFormState.valueOption. View source (scalive/api/src/scalive/forms/FormState.scala:120-120)

val raw: FormData

The untrusted payload the state was built from.

Defined by scalive.RawFormState.raw. View source (scalive/api/src/scalive/forms/FormState.scala:108-108)

val submitted: Boolean

Whether the payload is a submission, which makes every field count as used.

Defined by scalive.RawFormState.submitted. View source (scalive/api/src/scalive/forms/FormState.scala:111-111)

val used: Set[FormPath]

The browser paths in the payload, minus fields marked _unused_ unless it is a submission.

Defined by scalive.RawFormState.used. View source (scalive/api/src/scalive/forms/FormState.scala:110-110)

val value: util.Either[FormErrors[Any], A]

The codec's result: the decoded value or its errors.

Defined by scalive.RawFormState.value. View source (scalive/api/src/scalive/forms/FormState.scala:109-109)