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
  • ContentRangeUnits
  • ContentTypeRange
  • Encodings
  • HasHeaders
  • Header
  • HeaderNames
  • Headers
  • HttpVersion
  • MediaType
  • MediaTypes
  • Method
  • Methods
  • Part
  • QueryParams
  • RequestMetadata
  • ResponseMetadata
  • StatusCode
  • StatusCodes
  • StatusText
  • Uri
  • UriInterpolator

object StatusCode extends StatusCodes

For a description of the behavior of apply, safeApply and unsafeApply methods, see sttp.model.

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

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. val Accepted: StatusCode
    Definition Classes
    StatusCodes
  5. val AlreadyReported: StatusCode
    Definition Classes
    StatusCodes
  6. val BadGateway: StatusCode
    Definition Classes
    StatusCodes
  7. val BadRequest: StatusCode
    Definition Classes
    StatusCodes
  8. val Conflict: StatusCode
    Definition Classes
    StatusCodes
  9. val Continue: StatusCode
    Definition Classes
    StatusCodes
  10. val Created: StatusCode
    Definition Classes
    StatusCodes
  11. val EarlyHints: StatusCode
    Definition Classes
    StatusCodes
  12. val ExpectationFailed: StatusCode
    Definition Classes
    StatusCodes
  13. val FailedDependency: StatusCode
    Definition Classes
    StatusCodes
  14. val Forbidden: StatusCode
    Definition Classes
    StatusCodes
  15. val Found: StatusCode
    Definition Classes
    StatusCodes
  16. val GatewayTimeout: StatusCode
    Definition Classes
    StatusCodes
  17. val Gone: StatusCode
    Definition Classes
    StatusCodes
  18. val HttpVersionNotSupported: StatusCode
    Definition Classes
    StatusCodes
  19. val ImUsed: StatusCode
    Definition Classes
    StatusCodes
  20. val InsufficientStorage: StatusCode
    Definition Classes
    StatusCodes
  21. val InternalServerError: StatusCode
    Definition Classes
    StatusCodes
  22. val LengthRequired: StatusCode
    Definition Classes
    StatusCodes
  23. val Locked: StatusCode
    Definition Classes
    StatusCodes
  24. val LoopDetected: StatusCode
    Definition Classes
    StatusCodes
  25. val MethodNotAllowed: StatusCode
    Definition Classes
    StatusCodes
  26. val MisdirectedRequest: StatusCode
    Definition Classes
    StatusCodes
  27. val MovedPermanently: StatusCode
    Definition Classes
    StatusCodes
  28. val MultiStatus: StatusCode
    Definition Classes
    StatusCodes
  29. val MultipleChoices: StatusCode
    Definition Classes
    StatusCodes
  30. val NetworkAuthenticationRequired: StatusCode
    Definition Classes
    StatusCodes
  31. val NoContent: StatusCode
    Definition Classes
    StatusCodes
  32. val NonAuthoritativeInformation: StatusCode
    Definition Classes
    StatusCodes
  33. val NotAcceptable: StatusCode
    Definition Classes
    StatusCodes
  34. val NotExtended: StatusCode
    Definition Classes
    StatusCodes
  35. val NotFound: StatusCode
    Definition Classes
    StatusCodes
  36. val NotImplemented: StatusCode
    Definition Classes
    StatusCodes
  37. val NotModified: StatusCode
    Definition Classes
    StatusCodes
  38. val Ok: StatusCode
    Definition Classes
    StatusCodes
  39. val PartialContent: StatusCode
    Definition Classes
    StatusCodes
  40. val PayloadTooLarge: StatusCode
    Definition Classes
    StatusCodes
  41. val PaymentRequired: StatusCode
    Definition Classes
    StatusCodes
  42. val PermanentRedirect: StatusCode
    Definition Classes
    StatusCodes
  43. val PreconditionFailed: StatusCode
    Definition Classes
    StatusCodes
  44. val PreconditionRequired: StatusCode
    Definition Classes
    StatusCodes
  45. val Processing: StatusCode
    Definition Classes
    StatusCodes
  46. val ProxyAuthenticationRequired: StatusCode
    Definition Classes
    StatusCodes
  47. val RangeNotSatisfiable: StatusCode
    Definition Classes
    StatusCodes
  48. val RequestHeaderFieldsTooLarge: StatusCode
    Definition Classes
    StatusCodes
  49. val RequestTimeout: StatusCode
    Definition Classes
    StatusCodes
  50. val ResetContent: StatusCode
    Definition Classes
    StatusCodes
  51. val SeeOther: StatusCode
    Definition Classes
    StatusCodes
  52. val ServiceUnavailable: StatusCode
    Definition Classes
    StatusCodes
  53. val SwitchingProtocols: StatusCode
    Definition Classes
    StatusCodes
  54. val TemporaryRedirect: StatusCode
    Definition Classes
    StatusCodes
  55. def TooEarly: StatusCode
    Definition Classes
    StatusCodes
  56. val TooManyRequests: StatusCode
    Definition Classes
    StatusCodes
  57. val Unauthorized: StatusCode
    Definition Classes
    StatusCodes
  58. val UnavailableForLegalReasons: StatusCode
    Definition Classes
    StatusCodes
  59. val UnprocessableEntity: StatusCode
    Definition Classes
    StatusCodes
  60. val UnsupportedMediaType: StatusCode
    Definition Classes
    StatusCodes
  61. val UpgradeRequired: StatusCode
    Definition Classes
    StatusCodes
  62. val UriTooLong: StatusCode
    Definition Classes
    StatusCodes
  63. val UseProxy: StatusCode
    Definition Classes
    StatusCodes
  64. val VariantAlsoNegotiates: StatusCode
    Definition Classes
    StatusCodes
  65. def apply(code: Int): StatusCode
  66. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  67. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  68. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  69. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  70. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  71. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  72. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  73. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  74. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  75. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  76. def safeApply(code: Int): Either[String, StatusCode]
  77. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  78. def toString(): String
    Definition Classes
    AnyRef → Any
  79. def unsafeApply(code: Int): StatusCode

    Exceptions thrown

    IllegalArgumentException If the status code is out of range.

  80. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  81. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  82. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from StatusCodes

Inherited from AnyRef

Inherited from Any

Ungrouped