Class/Object

akka.http.scaladsl.model

MediaType

Related Docs: object MediaType | package model

Permalink

sealed abstract class MediaType extends javadsl.model.MediaType with LazyValueBytesRenderable with WithQValue[MediaRange]

A MediaType describes the type of the content of an HTTP message entity.

While knowledge of the MediaType alone suffices for being able to properly interpret binary content this is not generally the case for non-binary (i.e. character-based) content, which also requires the definition of a specific character encoding (HttpCharset). Therefore MediaType instances are frequently encountered as a member of a ContentType, which groups a MediaType with a potentially required HttpCharset to hold everything required for being able to interpret an HttpEntity.

MediaTypes come in three basic forms:

1. Binary: These do not need an additional HttpCharset to be able to form a ContentType. Therefore they can be implicitly converted to the latter.

2. WithOpenCharset: Most character-based MediaTypes are of this form, which can be combined with all HttpCharset instances to form a ContentType.

3. WithFixedCharset: Some character-based MediaTypes prescribe a single, clearly defined charset and as such, similarly to binary MediaTypes, do not require the addition of an HttpCharset instances to form a ContentType. The most prominent example is probably application/json which must always be UTF-8 encoded. Like binary MediaTypes WithFixedCharset types can be implicitly converted to a ContentType.

Source
MediaType.scala
Linear Supertypes
WithQValue[MediaRange], LazyValueBytesRenderable, Renderable, javadsl.model.MediaType, AnyRef, Any
Known Subclasses
Binary, Multipart, NonBinary, NonMultipartWithOpenCharset, WithFixedCharset, WithOpenCharset
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MediaType
  2. WithQValue
  3. LazyValueBytesRenderable
  4. Renderable
  5. MediaType
  6. AnyRef
  7. Any
Implicitly
  1. by apply
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def binary: Boolean

    Permalink

    True when this media-type is not character-based.

    True when this media-type is not character-based.

    Definition Classes
    MediaType

  2. abstract def comp: Compressibility

    Permalink

  3. abstract def fileExtensions: List[String]

    Permalink

  4. abstract def mainType: String

    Permalink

    The main-type of this media-type.

    The main-type of this media-type.

    Definition Classes
    MediaType

  5. abstract def params: Map[String, String]

    Permalink

  6. abstract def subType: String

    Permalink

    The sub-type of this media-type.

    The sub-type of this media-type.

    Definition Classes
    MediaType

  7. abstract def value: String

    Permalink
    Definition Classes
    LazyValueBytesRenderable

  8. abstract def withComp(comp: Compressibility): MediaType

    Permalink

  9. abstract def withParams(params: Map[String, String]): MediaType

    Permalink

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to any2stringadd[MediaType] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (MediaType, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to ArrowAssoc[MediaType] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (MediaType) ⇒ Boolean, msg: ⇒ Any): MediaType

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to Ensuring[MediaType] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (MediaType) ⇒ Boolean): MediaType

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to Ensuring[MediaType] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): MediaType

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to Ensuring[MediaType] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): MediaType

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to Ensuring[MediaType] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(that: Any): Boolean

    Permalink
    Definition Classes
    MediaType → AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to StringFormat[MediaType] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def getParams(): Map[String, String]

    Permalink

    Java API

    Java API

    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    Definition Classes
    MediaRange → MediaRange

  18. def hashCode(): Int

    Permalink
    Definition Classes
    MediaType → AnyRef → Any

  19. def isApplication: Boolean

    Permalink
    Definition Classes
    MediaType → MediaType

  20. def isAudio: Boolean

    Permalink
    Definition Classes
    MediaType → MediaType

  21. def isCompressible: Boolean

    Permalink

    True when this media-type is generally compressible.

    True when this media-type is generally compressible.

    Definition Classes
    MediaType → MediaType

  22. def isImage: Boolean

    Permalink
    Definition Classes
    MediaType → MediaType

  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  24. def isMessage: Boolean

    Permalink
    Definition Classes
    MediaType → MediaType

  25. def isMultipart: Boolean

    Permalink
    Definition Classes
    MediaType → MediaType

  26. def isText: Boolean

    Permalink
    Definition Classes
    MediaType → MediaType

  27. def isVideo: Boolean

    Permalink
    Definition Classes
    MediaType → MediaType

  28. def isWildcard: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    Definition Classes
    MediaRange

  29. def matches(mediaType: javadsl.model.MediaType): Boolean

    Permalink

    Java API

    Java API

    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    Definition Classes
    MediaRange → MediaRange

  30. def matches(mediaType: MediaType): Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    Definition Classes
    MediaRange

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

    Permalink
    Definition Classes
    AnyRef

  32. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  33. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  34. def qValue(): Float

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    Definition Classes
    MediaRange → MediaRange

  35. def render[R <: Rendering](r: R): r.type

    Permalink
    Definition Classes
    LazyValueBytesRenderable → Renderable

  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  37. def toRange(qValue: Float): javadsl.model.MediaRange

    Permalink

    Creates a media-range from this media-type with a given qValue.

    Creates a media-range from this media-type with a given qValue.

    Definition Classes
    MediaType → MediaType

  38. def toRange: javadsl.model.MediaRange

    Permalink

    JAVA API

    JAVA API

    Definition Classes
    MediaType → MediaType

  39. def toString(): String

    Permalink
    Definition Classes
    LazyValueBytesRenderable → AnyRef → Any

  40. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  42. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  43. def withCharsetRange(charsetRange: HttpCharsetRange): ContentTypeRange

    Permalink

    Constructs a ContentTypeRange from this instance and the given charset.

    Constructs a ContentTypeRange from this instance and the given charset.

    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    Definition Classes
    MediaRange

  44. def withQValue(qValue: Float): MediaRange

    Permalink
    Definition Classes
    MediaType → WithQValue

  45. def withQValue(qValue: Double): MediaRange

    Permalink

    truncates Double qValue to float and returns a new instance with this qValue set

    truncates Double qValue to float and returns a new instance with this qValue set

    Definition Classes
    WithQValue

  46. def →[B](y: B): (MediaType, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to ArrowAssoc[MediaType] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def isApplication: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    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:
    (mediaType: MediaRange).isApplication
    Definition Classes
    MediaRange

  2. def isAudio: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    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:
    (mediaType: MediaRange).isAudio
    Definition Classes
    MediaRange

  3. def isImage: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    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:
    (mediaType: MediaRange).isImage
    Definition Classes
    MediaRange

  4. def isMessage: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    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:
    (mediaType: MediaRange).isMessage
    Definition Classes
    MediaRange

  5. def isMultipart: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    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:
    (mediaType: MediaRange).isMultipart
    Definition Classes
    MediaRange

  6. def isText: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    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:
    (mediaType: MediaRange).isText
    Definition Classes
    MediaRange

  7. def isVideo: Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    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:
    (mediaType: MediaRange).isVideo
    Definition Classes
    MediaRange

  8. def mainType(): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    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:
    (mediaType: MediaRange).mainType()
    Definition Classes
    MediaRange → MediaRange

  9. def params: Map[String, String]

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    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:
    (mediaType: MediaRange).params
    Definition Classes
    MediaRange

  10. def value: String

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    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:
    (mediaType: MediaRange).value
    Definition Classes
    MediaRange

  11. def withParams(params: Map[String, String]): MediaRange

    Permalink

    Returns a copy of this instance with the params replaced by the given ones.

    Returns a copy of this instance with the params replaced by the given ones. If the given map contains a "q" value the qValue member is (also) updated.

    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    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:
    (mediaType: MediaRange).withParams(params)
    Definition Classes
    MediaRange

  12. def withQValue(qValue: Double): MediaRange

    Permalink

    truncates Double qValue to float and returns a new instance with this qValue set

    truncates Double qValue to float and returns a new instance with this qValue set

    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    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:
    (mediaType: MediaRange).withQValue(qValue)
    Definition Classes
    WithQValue

  13. def withQValue(qValue: Float): MediaRange

    Permalink
    Implicit information
    This member is added by an implicit conversion from MediaType to MediaRange performed by method apply in akka.http.scaladsl.model.MediaRange.
    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:
    (mediaType: MediaRange).withQValue(qValue)
    Definition Classes
    WithQValue

Inherited from WithQValue[MediaRange]

Inherited from LazyValueBytesRenderable

Inherited from Renderable

Inherited from javadsl.model.MediaType

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion apply from MediaType to MediaRange

Inherited by implicit conversion any2stringadd from MediaType to any2stringadd[MediaType]

Inherited by implicit conversion StringFormat from MediaType to StringFormat[MediaType]

Inherited by implicit conversion Ensuring from MediaType to Ensuring[MediaType]

Inherited by implicit conversion ArrowAssoc from MediaType to ArrowAssoc[MediaType]

Ungrouped