Packages

c

sttp.tapir.EndpointOutput

FixedStatusCode

case class FixedStatusCode[T](statusCode: model.StatusCode, codec: Codec[Unit, T, TextPlain], info: Info[T]) extends Atom[T] with Product with Serializable

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FixedStatusCode
  2. Serializable
  3. Product
  4. Equals
  5. Atom
  6. Atom
  7. Basic
  8. Basic
  9. Single
  10. EndpointOutput
  11. EndpointTransput
  12. EndpointTransputMacros
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FixedStatusCode(statusCode: model.StatusCode, codec: Codec[Unit, T, TextPlain], info: Info[T])

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. def and[J, IJ](other: EndpointOutput[J])(implicit concat: typelevel.ParamConcat.Aux[T, J, IJ]): EndpointOutput[IJ]
    Definition Classes
    EndpointOutput
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def attribute[A](k: AttributeKey[A], v: A): ThisType[T]
    Definition Classes
    Atom
  7. def attribute[A](k: AttributeKey[A]): Option[A]
    Definition Classes
    Atom
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. val codec: Codec[Unit, T, TextPlain]
    Definition Classes
    FixedStatusCodeAtom
  10. def default(d: T): ThisType[T]
    Definition Classes
    Atom
  11. def deprecated(): ThisType[T]
    Definition Classes
    Atom
  12. def description(d: String): ThisType[T]
    Definition Classes
    Atom
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def example(example: Example[T]): ThisType[T]
    Definition Classes
    Atom
  15. def example(t: T): ThisType[T]
    Definition Classes
    Atom
  16. def examples(examples: List[Example[T]]): ThisType[T]
    Definition Classes
    Atom
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. val info: Info[T]
    Definition Classes
    FixedStatusCodeAtom
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def map[U](mapping: Mapping[T, U]): ThisType[U]
    Definition Classes
    AtomEndpointTransput
  21. def map[U](f: (T) => U)(g: (U) => T): ThisType[U]
    Definition Classes
    EndpointTransput
  22. def mapDecode[U](f: (T) => DecodeResult[U])(g: (U) => T): ThisType[U]
    Definition Classes
    EndpointTransput
  23. macro def mapTo[CASE_CLASS]: ThisType[CASE_CLASS]
    Definition Classes
    EndpointTransputMacros
  24. def mapValidate[U](v: Validator[T])(f: (T) => U)(g: (U) => T): ThisType[U]

    Adds the given validator, and maps to the given higher-level type U.

    Adds the given validator, and maps to the given higher-level type U.

    Unlike a .validate(v).map(f)(g) invocation, during decoding the validator is run before applying the f function. If there are validation errors, decoding fails. However, the validator is then invoked again on the fully decoded value.

    This is useful to create inputs/outputs for types, which are unrepresentable unless the validator's condition is met, e.g. due to preconditions in the constructor.

    Definition Classes
    EndpointTransput
    See also

    validate

  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def productElementNames: Iterator[String]
    Definition Classes
    Product
  29. def schema(modify: (Schema[T]) => Schema[T]): ThisType[T]
    Definition Classes
    Atom
  30. def schema(s: Option[Schema[T]]): ThisType[T]
    Definition Classes
    Atom
  31. def schema(s: Schema[T]): ThisType[T]
    Definition Classes
    Atom
  32. def show: String
    Definition Classes
    FixedStatusCodeEndpointTransput
  33. val statusCode: model.StatusCode
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def validate(v: Validator[T]): ThisType[T]

    Adds a validator.

    Adds a validator.

    Note that validation is run on a fully decoded value. That is, during decoding, first the decoding functions are run, followed by validations. Hence any functions provided in subsequent .maps or .mapDecodes will be invoked before validation.

    Definition Classes
    EndpointTransput
    See also

    mapValidate

  36. def validateIterable[C[X] <: Iterable[X], U](v: Validator[U])(implicit tIsCU: =:=[T, C[U]]): ThisType[T]

    Adds a validator which validates each element in the collection.

    Adds a validator which validates each element in the collection.

    Should only be used if the schema hasn't been created by .mapping another one, but directly from Schema[U]. Otherwise the shape of the schema doesn't correspond to the type T, but to some lower-level representation of the type. This might cause invalid results at run-time.

    Definition Classes
    Atom
  37. def validateOption[U](v: Validator[U])(implicit tIsOptionU: =:=[T, Option[U]]): ThisType[T]

    Adds a validator which validates the option's element, if it is present.

    Adds a validator which validates the option's element, if it is present.

    Should only be used if the schema hasn't been created by .mapping another one, but directly from Schema[U]. Otherwise the shape of the schema doesn't correspond to the type T, but to some lower-level representation of the type. This might cause invalid results at run-time.

    Definition Classes
    Atom
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. 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
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Atom[T]

Inherited from EndpointTransput.Atom[T]

Inherited from Basic[T]

Inherited from EndpointTransput.Basic[T]

Inherited from Single[T]

Inherited from EndpointOutput[T]

Inherited from EndpointTransput[T]

Inherited from EndpointTransputMacros[T]

Inherited from AnyRef

Inherited from Any

Ungrouped