sealed trait FormDataDecoder[A] extends AnyRef
A decoder ware that uses QueryParamDecoder to decode values in org.http4s.UrlForm
- Source
- FormDataDecoder.scala
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.
, 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
- Alphabetic
- By Inheritance
- FormDataDecoder
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def apply(data: Map[String, Chain[String]]): ValidatedNel[ParseFailure, A]
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def mapValidated[B](f: (A) => ValidatedNel[ParseFailure, B]): FormDataDecoder[B]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def sanitized: FormDataDecoder[A]
Filters out empty strings including spaces before decoding
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()