docs
API
Generated with
docs/zio.http/Form

Form

zio.http.Form
See theForm companion object
final case class Form(formData: Chunk[FormField])

Represents a form that can be either multipart or url encoded.

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def +(field: FormField): Form

Returns a new form with the specified field appended.

Returns a new form with the specified field appended.

Attributes

def append(field: FormField): Form

Returns a new form with the specified field appended.

Returns a new form with the specified field appended.

Attributes

def collectAll(implicit trace: Trace): ZIO[Any, Throwable, Form]

Runs all streaming form data and stores them in memory, returning a Form that has no streaming parts.

Runs all streaming form data and stores them in memory, returning a Form that has no streaming parts.

Attributes

def get(name: String): Option[FormField]

Returns the first field with the specified name.

Returns the first field with the specified name.

Attributes

def multipartBytes(boundary: Boundary)(implicit trace: Trace): ZStream[Any, Nothing, Byte]

Encodes the form using multipart encoding, using the specified boundary.

Encodes the form using multipart encoding, using the specified boundary.

Attributes

def multipartBytesUUID(implicit trace: Trace): UIO[(Boundary, ZStream[Any, Nothing, Byte])]

Encodes the form using multipart encoding, choosing a random UUID as the boundary.

Encodes the form using multipart encoding, choosing a random UUID as the boundary.

Attributes

def urlEncoded: String

Encodes the form using URL encoding, using the default charset.

Encodes the form using URL encoding, using the default charset.

Attributes

def urlEncoded(charset: Charset): String

Encodes the form using URL encoding, using the specified charset. Ignores any data that cannot be URL encoded.

Encodes the form using URL encoding, using the specified charset. Ignores any data that cannot be URL encoded.

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

lazy val map: Map[String, FormField]

Returns a map view of the form, where the keys in the map are the field names, and the values are the field data.

Returns a map view of the form, where the keys in the map are the field names, and the values are the field data.

Attributes

Generated with