Packages

final class EncodingNegotiator extends AnyRef

Source
ContentNegotation.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EncodingNegotiator
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new EncodingNegotiator(requestHeaders: Seq[HttpHeader])

Value Members

  1. val acceptedEncodingRanges: List[HttpEncodingRange]

    The encoding-ranges accepted by the client according to given request headers, sorted by 1.

    The encoding-ranges accepted by the client according to given request headers, sorted by 1. increasing generality (i.e. most specific first) 2. decreasing q-value (only for ranges targeting a single HttpEncoding) 3. order of appearance in the Accept-Encoding header(s)

  2. def hasMatchingFor(encoding: HttpEncoding): Boolean

    Determines whether the request has an Accept-Encoding clause matching the given encoding.

  3. def isAccepted(encoding: HttpEncoding): Boolean

    Determines whether the given encoding is accepted by the client.

  4. def pickEncoding(alternatives: List[HttpEncoding]): Option[HttpEncoding]

    Picks the best of the given encoding alternatives given the preferences the client indicated in the request's Accept-Encoding headers.

    Picks the best of the given encoding alternatives given the preferences the client indicated in the request's Accept-Encoding headers. See http://tools.ietf.org/html/rfc7231#section-5.3.4 for details on the negotiation logic.

    If there are several best encoding alternatives that the client has equal preference for the order of the given alternatives is used as a tie breaker (first one wins).

    If none of the given alternatives is acceptable to the client the methods return None.

  5. def qValueFor(encoding: HttpEncoding): Float

    Returns the q-value that the client (implicitly or explicitly) attaches to the given encoding.

    Returns the q-value that the client (implicitly or explicitly) attaches to the given encoding. See http://tools.ietf.org/html/rfc7231#section-5.3.1 for details.