Packages

  • package root
    Definition Classes
    root
  • package sttp
    Definition Classes
    root
  • package model

    Most model classes contain both serialisation & parsing functionality, following these conventions:

    Most model classes contain both serialisation & parsing functionality, following these conventions:

    • .toString returns a representation of the model class in a format as in an HTTP request/response. For example, for an uri this will be http://..., for a header [name]: [value], etc.
    • [SthCompanionObject].parse(serialized: String): Either[String, Sth]: returns an error message or an instance of the model class
    • [SthCompanionObject].unsafeParse(serialized: String): Sth: returns an instance of the model class or in case of an error, *throws an exception*.
    • [SthCompanionObject].unsafeApply(values): creates an instance of the model class; validates the input values and in case of an error, *throws an exception*. An error could be e.g. that the input values contain characters outside of the allowed range
    • [SthCompanionObject].safeApply(...): Either[String, Sth]: same as above, but doesn't throw exceptions. Instead, returns an error message or the model class instance
    • [SthCompanionObject].apply(...): Sth: creates the model type, without validation, and without throwing exceptions
    Definition Classes
    sttp
  • package headers
    Definition Classes
    model
  • package internal
    Definition Classes
    model
  • package sse
    Definition Classes
    model
  • HasHeaders
  • Header
  • HeaderNames
  • Headers
  • MediaType
  • MediaTypes
  • Method
  • Methods
  • Part
  • QueryParams
  • RequestMetadata
  • ResponseMetadata
  • StatusCode
  • StatusCodes
  • Uri
  • UriInterpolator

case class Part[+T](name: String, body: T, otherDispositionParams: Map[String, String], headers: Seq[Header]) extends HasHeaders with Product with Serializable

A decoded representation of a multipart part.

Linear Supertypes
Serializable, Product, Equals, HasHeaders, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Part
  2. Serializable
  3. Product
  4. Equals
  5. HasHeaders
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Part(name: String, body: T, otherDispositionParams: Map[String, String], headers: Seq[Header])

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. val body: T
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. def contentDispositionHeaderValue: String
  8. def contentLength: Option[Long]
    Definition Classes
    HasHeaders
  9. def contentType: Option[String]
    Definition Classes
    Part → HasHeaders
  10. def contentType(v: String): Part[T]
  11. def contentType(v: MediaType): Part[T]
  12. def cookies: Seq[Either[String, CookieWithMeta]]
    Definition Classes
    HasHeaders
  13. def dispositionParam(k: String, v: String): Part[T]
  14. def dispositionParams: Map[String, String]
  15. def dispositionParamsSeq: Seq[(String, String)]
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def fileName: Option[String]
  18. def fileName(v: String): Part[T]
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def header(h: String): Option[String]
    Definition Classes
    Part → HasHeaders
  21. def header(k: String, v: String, replaceExisting: Boolean): Part[T]

    Adds the given header to the end of the headers sequence.

    Adds the given header to the end of the headers sequence.

    replaceExisting

    If there's already a header with the same name, should it be dropped?

  22. def header(k: String, v: String): Part[T]
  23. def header(h: Header, replaceExisting: Boolean = false): Part[T]

    Adds the given header to the end of the headers sequence.

    Adds the given header to the end of the headers sequence.

    replaceExisting

    If there's already a header with the same name, should it be dropped?

  24. def headers(h: String): Seq[String]
    Definition Classes
    HasHeaders
  25. val headers: Seq[Header]
    Definition Classes
    Part → HasHeaders
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. val name: String
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. val otherDispositionParams: Map[String, String]
  32. def productElementNames: Iterator[String]
    Definition Classes
    Product
  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. def unsafeCookies: Seq[CookieWithMeta]
    Definition Classes
    HasHeaders
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HasHeaders

Inherited from AnyRef

Inherited from Any

Ungrouped