StreamBodyIO

case class StreamBodyIO[BS, T, S](streams: Streams[S], codec: Codec[BS, T, CodecFormat], info: Info[T], charset: Option[Charset], encodedExamples: List[Example[Any]]) extends Atom[T]
trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Basic[T]
class Object
trait Matchable
class Any

Value members

Concrete methods

def encodedExample(e: Any): ThisType[T]

Add an example of a "deserialized" stream value. This should be given in an encoded form, e.g. in case of json - as a String, as the stream body doesn't have access to the codec that will be later used for deserialization.

Add an example of a "deserialized" stream value. This should be given in an encoded form, e.g. in case of json - as a String, as the stream body doesn't have access to the codec that will be later used for deserialization.

def encodedExample(example: Example[Any]): ThisType[T]
def encodedExample(examples: List[Example[Any]]): ThisType[T]
override def show: String
Definition Classes

Lift this streaming body into an EndpointIO, so that it can be used as a regular endpoint input/output, "forgetting" the streaming requirement. This is useful when using the streaming body in Tapir.oneOf or Tapir.oneOfBody, however at the expense of type safety: the fact that the endpoint can only be interpreted by an interpreter supporting the given stream type is lost; in case of a mismatch, a run-time error will occur.

Lift this streaming body into an EndpointIO, so that it can be used as a regular endpoint input/output, "forgetting" the streaming requirement. This is useful when using the streaming body in Tapir.oneOf or Tapir.oneOfBody, however at the expense of type safety: the fact that the endpoint can only be interpreted by an interpreter supporting the given stream type is lost; in case of a mismatch, a run-time error will occur.

Inherited methods

def attribute[A](k: AttributeKey[A], v: A): ThisType[T]
Inherited from:
Atom
def attribute[A](k: AttributeKey[A]): Option[A]
Inherited from:
Atom
def default(d: T): ThisType[T]
Inherited from:
Atom
def deprecated(): ThisType[T]
Inherited from:
Atom
def description(d: String): ThisType[T]
Inherited from:
Atom
def example(example: Example[T]): ThisType[T]
Inherited from:
Atom
def example(t: T): ThisType[T]
Inherited from:
Atom
def examples(examples: List[Example[T]]): ThisType[T]
Inherited from:
Atom
override def map[U](mapping: Mapping[T, U]): ThisType[U]
Definition Classes
Inherited from:
Atom
def map[U](f: T => U)(g: U => T): ThisType[U]
Inherited from:
EndpointTransput
def mapDecode[U](f: T => DecodeResult[U])(g: U => T): ThisType[U]
Inherited from:
EndpointTransput
inline def mapTo[CASE_CLASS <: Product](using mc: ProductOf[CASE_CLASS]): ThisType[CASE_CLASS]
Inherited from:
EndpointTransputMacros
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product
def schema(modify: Schema[T] => Schema[T]): ThisType[T]
Inherited from:
Atom
def schema(s: Option[Schema[T]]): ThisType[T]
Inherited from:
Atom
def schema(s: Schema[T]): ThisType[T]
Inherited from:
Atom
def validate(v: Validator[T]): ThisType[T]
Inherited from:
EndpointTransput
def validateIterable[C <: (Iterable), U](v: Validator[U])(implicit tIsCU: T =:= C[U]): ThisType[T]
Inherited from:
Atom
def validateOption[U](v: Validator[U])(implicit tIsOptionU: T =:= Option[U]): ThisType[T]
Inherited from:
Atom