EncodingNegotiator

org.apache.pekko.http.scaladsl.server.EncodingNegotiator
See theEncodingNegotiator companion object
final class EncodingNegotiator(requestHeaders: Seq[HttpHeader])

Attributes

Companion
object
Source
ContentNegotiation.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

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

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

Attributes

Source
ContentNegotiation.scala
def isAccepted(encoding: HttpEncoding): Boolean

Determines whether the given encoding is accepted by the client.

Determines whether the given encoding is accepted by the client.

Attributes

Source
ContentNegotiation.scala

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.

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.

Attributes

Source
ContentNegotiation.scala
def qValueFor(encoding: HttpEncoding): Float

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.

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.

Attributes

Source
ContentNegotiation.scala

Concrete fields

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

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)

Attributes

Source
ContentNegotiation.scala