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 Method extends Methods with Serializable

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

Linear Supertypes
Serializable, Serializable, Methods, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Method
  2. Serializable
  3. Serializable
  4. Methods
  5. AnyRef
  6. 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 CONNECT: Method
    Definition Classes
    Methods
  5. val DELETE: Method
    Definition Classes
    Methods
  6. val GET: Method
    Definition Classes
    Methods
  7. val HEAD: Method
    Definition Classes
    Methods
  8. val OPTIONS: Method
    Definition Classes
    Methods
  9. val PATCH: Method
    Definition Classes
    Methods
  10. val POST: Method
    Definition Classes
    Methods
  11. val PUT: Method
    Definition Classes
    Methods
  12. val TRACE: Method
    Definition Classes
    Methods
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def isIdempotent(m: Method): Boolean

    An HTTP method is idempotent if an identical request can be made once or several times in a row with the same effect while leaving the server in the same state.

    An HTTP method is idempotent if an identical request can be made once or several times in a row with the same effect while leaving the server in the same state.

    See also

    https://developer.mozilla.org/en-US/docs/Glossary/Idempotent

  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def isSafe(m: Method): Boolean

    An HTTP method is safe if it doesn't alter the state of the server.

    An HTTP method is safe if it doesn't alter the state of the server.

    See also

    https://developer.mozilla.org/en-US/docs/Glossary/safe

  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def safeApply(method: String): Either[String, Method]
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. def unsafeApply(method: String): Method

    Exceptions thrown

    IllegalArgumentException If the method value is not a valid token.

  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. 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 Serializable

Inherited from Serializable

Inherited from Methods

Inherited from AnyRef

Inherited from Any

Ungrouped