akka.http.scaladsl.marshalling

Marshaller

sealed abstract class Marshaller[-A, +B] extends AnyRef

Source
Marshaller.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Marshaller
  2. AnyRef
  3. Any
Implicitly
  1. by liftMarshallerConversion
  2. by any2stringadd
  3. by any2stringfmt
  4. by any2ArrowAssoc
  5. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Marshaller()

Abstract Value Members

  1. abstract def apply(value: A)(implicit ec: ExecutionContext): Future[List[Marshalling[B]]]

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Marshaller[A, B], B)

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to ArrowAssoc[Marshaller[A, B]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def compose[C](f: (C) ⇒ A): Marshaller[C, B]

  11. def composeWithEC[C](f: (ExecutionContext) ⇒ (C) ⇒ A): Marshaller[C, B]

  12. def ensuring(cond: (Marshaller[A, B]) ⇒ Boolean, msg: ⇒ Any): Marshaller[A, B]

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to Ensuring[Marshaller[A, B]] performed by method any2Ensuring in scala.Predef. This conversion will take place only if B is a subclass of MessageEntity (B <: MessageEntity).
    Definition Classes
    Ensuring
  13. def ensuring(cond: (Marshaller[A, B]) ⇒ Boolean): Marshaller[A, B]

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to Ensuring[Marshaller[A, B]] performed by method any2Ensuring in scala.Predef. This conversion will take place only if B is a subclass of MessageEntity (B <: MessageEntity).
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): Marshaller[A, B]

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to Ensuring[Marshaller[A, B]] performed by method any2Ensuring in scala.Predef. This conversion will take place only if B is a subclass of MessageEntity (B <: MessageEntity).
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): Marshaller[A, B]

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to Ensuring[Marshaller[A, B]] performed by method any2Ensuring in scala.Predef. This conversion will take place only if B is a subclass of MessageEntity (B <: MessageEntity).
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  23. def map[C](f: (B) ⇒ C): Marshaller[A, C]

  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  28. def toString(): String

    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def wrap[C, D >: B](contentType: ContentType)(f: (C) ⇒ A)(implicit mto: MediaTypeOverrider[D]): Marshaller[C, D]

    Reuses this Marshaller's logic to produce a new Marshaller from another type C which overrides the produced ContentType with another one.

    Reuses this Marshaller's logic to produce a new Marshaller from another type C which overrides the produced ContentType with another one. Depending on whether the given ContentType has a defined charset or not and whether the underlying marshaller marshals with a fixed charset it can happen, that the wrapping becomes illegal. For example, a marshaller producing content encoded with UTF-16 cannot be wrapped with a ContentType that has a defined charset of UTF-8, since akka-http will never recode entities. If the wrapping is illegal the Future produced by the resulting marshaller will contain a RuntimeException.

  33. def wrapWithEC[C, D >: B](contentType: ContentType)(f: (ExecutionContext) ⇒ (C) ⇒ A)(implicit mto: MediaTypeOverrider[D]): Marshaller[C, D]

    Reuses this Marshaller's logic to produce a new Marshaller from another type C which overrides the produced ContentType with another one.

    Reuses this Marshaller's logic to produce a new Marshaller from another type C which overrides the produced ContentType with another one. Depending on whether the given ContentType has a defined charset or not and whether the underlying marshaller marshals with a fixed charset it can happen, that the wrapping becomes illegal. For example, a marshaller producing content encoded with UTF-16 cannot be wrapped with a ContentType that has a defined charset of UTF-8, since akka-http will never recode entities. If the wrapping is illegal the Future produced by the resulting marshaller will contain a RuntimeException.

  34. def [B](y: B): (Marshaller[A, B], B)

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to ArrowAssoc[Marshaller[A, B]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def apply(value: T)(implicit ec: ExecutionContext): Future[List[Marshalling[HttpResponse]]]

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to ToResponseMarshaller[T] performed by method liftMarshallerConversion in akka.http.scaladsl.marshalling.LowPriorityToResponseMarshallerImplicits. This conversion will take place only if A is a superclass of T (A >: T) and at the same time B is a subclass of MessageEntity (B <: MessageEntity).
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (marshaller: ToResponseMarshaller[T]).apply(value)(ec)
  2. def compose[C](f: (C) ⇒ T): Marshaller[C, HttpResponse]

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to ToResponseMarshaller[T] performed by method liftMarshallerConversion in akka.http.scaladsl.marshalling.LowPriorityToResponseMarshallerImplicits. This conversion will take place only if A is a superclass of T (A >: T) and at the same time B is a subclass of MessageEntity (B <: MessageEntity).
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (marshaller: ToResponseMarshaller[T]).compose(f)
  3. def composeWithEC[C](f: (ExecutionContext) ⇒ (C) ⇒ T): Marshaller[C, HttpResponse]

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to ToResponseMarshaller[T] performed by method liftMarshallerConversion in akka.http.scaladsl.marshalling.LowPriorityToResponseMarshallerImplicits. This conversion will take place only if A is a superclass of T (A >: T) and at the same time B is a subclass of MessageEntity (B <: MessageEntity).
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (marshaller: ToResponseMarshaller[T]).composeWithEC(f)
  4. def map[C](f: (HttpResponse) ⇒ C): Marshaller[T, C]

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to ToResponseMarshaller[T] performed by method liftMarshallerConversion in akka.http.scaladsl.marshalling.LowPriorityToResponseMarshallerImplicits. This conversion will take place only if A is a superclass of T (A >: T) and at the same time B is a subclass of MessageEntity (B <: MessageEntity).
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (marshaller: ToResponseMarshaller[T]).map(f)
  5. val self: Any

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (marshaller: StringAdd).self
    Definition Classes
    StringAdd
  6. val self: Any

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (marshaller: StringFormat).self
    Definition Classes
    StringFormat
  7. def wrap[C, D >: B](contentType: ContentType)(f: (C) ⇒ T)(implicit mto: MediaTypeOverrider[D]): Marshaller[C, D]

    Reuses this Marshaller's logic to produce a new Marshaller from another type C which overrides the produced ContentType with another one.

    Reuses this Marshaller's logic to produce a new Marshaller from another type C which overrides the produced ContentType with another one. Depending on whether the given ContentType has a defined charset or not and whether the underlying marshaller marshals with a fixed charset it can happen, that the wrapping becomes illegal. For example, a marshaller producing content encoded with UTF-16 cannot be wrapped with a ContentType that has a defined charset of UTF-8, since akka-http will never recode entities. If the wrapping is illegal the Future produced by the resulting marshaller will contain a RuntimeException.

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to ToResponseMarshaller[T] performed by method liftMarshallerConversion in akka.http.scaladsl.marshalling.LowPriorityToResponseMarshallerImplicits. This conversion will take place only if A is a superclass of T (A >: T) and at the same time B is a subclass of MessageEntity (B <: MessageEntity).
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (marshaller: ToResponseMarshaller[T]).wrap(contentType)(f)(mto)
  8. def wrapWithEC[C, D >: B](contentType: ContentType)(f: (ExecutionContext) ⇒ (C) ⇒ T)(implicit mto: MediaTypeOverrider[D]): Marshaller[C, D]

    Reuses this Marshaller's logic to produce a new Marshaller from another type C which overrides the produced ContentType with another one.

    Reuses this Marshaller's logic to produce a new Marshaller from another type C which overrides the produced ContentType with another one. Depending on whether the given ContentType has a defined charset or not and whether the underlying marshaller marshals with a fixed charset it can happen, that the wrapping becomes illegal. For example, a marshaller producing content encoded with UTF-16 cannot be wrapped with a ContentType that has a defined charset of UTF-8, since akka-http will never recode entities. If the wrapping is illegal the Future produced by the resulting marshaller will contain a RuntimeException.

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to ToResponseMarshaller[T] performed by method liftMarshallerConversion in akka.http.scaladsl.marshalling.LowPriorityToResponseMarshallerImplicits. This conversion will take place only if A is a superclass of T (A >: T) and at the same time B is a subclass of MessageEntity (B <: MessageEntity).
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (marshaller: ToResponseMarshaller[T]).wrapWithEC(contentType)(f)(mto)

Deprecated Value Members

  1. def x: Marshaller[A, B]

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to ArrowAssoc[Marshaller[A, B]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (marshaller: ArrowAssoc[Marshaller[A, B]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Marshaller[A, B]

    Implicit information
    This member is added by an implicit conversion from Marshaller[A, B] to Ensuring[Marshaller[A, B]] performed by method any2Ensuring in scala.Predef. This conversion will take place only if B is a subclass of MessageEntity (B <: MessageEntity).
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (marshaller: Ensuring[Marshaller[A, B]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion liftMarshallerConversion from Marshaller[A, B] to ToResponseMarshaller[T]

Inherited by implicit conversion any2stringadd from Marshaller[A, B] to StringAdd

Inherited by implicit conversion any2stringfmt from Marshaller[A, B] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Marshaller[A, B] to ArrowAssoc[Marshaller[A, B]]

Inherited by implicit conversion any2Ensuring from Marshaller[A, B] to Ensuring[Marshaller[A, B]]

Ungrouped