FormField

zio.http.FormField
See theFormField companion trait
object FormField

Attributes

Companion
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
FormField.type

Members list

Type members

Classlikes

final case class Binary(name: String, data: Chunk[Byte], contentType: MediaType, transferEncoding: Option[ContentTransferEncoding], filename: Option[String]) extends FormField

A binary form data part.

A binary form data part.

Value parameters

contentType

The content type of this form data part. This is the value of the Content-Type with in this part.

data

The data of this form data part. This is the data between the headers and the boundary.

name

Name of this form data part. This is the value of the name field in the Content-Disposition within this part.

transferEncoding

The transfer encoding of this form data part. This is the value of the Content-Transfer-Encoding within this part. IMPORTANT NOTE: The data is not encoded in any way relative to the provided transferEncoding. It is the responsibility of the user to encode the data accordingly.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait FormField
class Object
trait Matchable
class Any
Show all
final case class Simple(name: String, value: String) extends FormField

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait FormField
class Object
trait Matchable
class Any
Show all
final case class StreamingBinary(name: String, contentType: MediaType, transferEncoding: Option[ContentTransferEncoding], filename: Option[String], data: ZStream[Any, Nothing, Byte]) extends FormField

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait FormField
class Object
trait Matchable
class Any
Show all
final case class Text(name: String, value: String, contentType: MediaType, filename: Option[String]) extends FormField

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait FormField
class Object
trait Matchable
class Any
Show all

Inherited types

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def binaryField(name: String, data: Chunk[Byte], mediaType: MediaType, transferEncoding: Option[ContentTransferEncoding], filename: Option[String]): FormField
def simpleField(name: String, value: String): FormField
def streamingBinaryField(name: String, data: ZStream[Any, Nothing, Byte], mediaType: MediaType, transferEncoding: Option[ContentTransferEncoding], filename: Option[String]): FormField
def textField(name: String, value: String, mediaType: MediaType): FormField