Packages

sealed trait FormDataDecoder[A] extends AnyRef

A decoder ware that uses QueryParamDecoder to decode values in org.http4s.UrlForm

Source
FormDataDecoder.scala
Examples: 

  1. scala> import cats.syntax.all._
scala> import cats.data._
scala> import org.http4s.FormDataDecoder._
scala> import org.http4s.ParseFailure
scala> case class Foo(a: String, b: Boolean)
scala> case class Bar(fs: List[Foo], f: Foo, d: Boolean)
scala>
scala> implicit val fooMapper: FormDataDecoder[Foo] = (
     |   field[String]("a"),
     |   field[Boolean]("b")
     | ).mapN(Foo.apply)
scala>
scala> val barMapper = (
     |   list[Foo]("fs"),
     |   nested[Foo]("f"),
     |   field[Boolean]("d")
     | ).mapN(Bar.apply)
scala>
scala> barMapper(
     |   Map(
     |    "fs[].a" -> Chain("a1", "a2"),
     |    "fs[].b" -> Chain("true", "false"),
     |    "f.a" -> Chain("fa"),
     |    "f.b" -> Chain("false"),
     |    "d" -> Chain("true"))
     | )
res1: ValidatedNel[ParseFailure, Bar] = Valid(Bar(List(Foo(a1,true), Foo(a2,false)),Foo(fa,false),true))

    The companion object provides a EntityDecoder from HTML form parameters.

    2. , 

  2. import org.http4s.FormDataDecoder.formEntityDecoder
HttpRoutes
 .of[F] {
   case req @ POST -> Root =>
     req.as[MyEntity].flatMap { entity =>
       Ok()
     }
 }

    For more examples, check the tests https://github.com/http4s/http4s/blob/main/tests/src/test/scala/org/http4s/FormDataDecoderSpec.scala

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FormDataDecoder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def apply(data: Map[String, Chain[String]]): ValidatedNel[ParseFailure, A]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def mapValidated[B](f: (A) ⇒ ValidatedNel[ParseFailure, B]): FormDataDecoder[B]
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def sanitized: FormDataDecoder[A]

    Filters out empty strings including spaces before decoding

  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped