Enum Class Coder
- All Implemented Interfaces:
Serializable,Comparable<Coder>,Constable
A coder is an implementation of the predefined encoders/decoders defined for HTTP.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe 'zstd' encoding, which needs the optionalcom.github.luben:zstd-jnidependency on the classpath. -
Method Summary
Modifier and TypeMethodDescriptionCompletionStage<org.apache.pekko.util.ByteString>decode(org.apache.pekko.util.ByteString input, org.apache.pekko.stream.Materializer mat) decodeMessage(HttpRequest message) decodeMessage(HttpResponse message) static HttpRequestdecodeRequest(HttpRequest request, Coder... coders) Decodes the request with the one ofcoderswhose encoding matches the request'sContent-Encodingheader, seedecodeResponse(HttpResponse, Coder...).static HttpResponsedecodeResponse(HttpResponse response, Coder... coders) Decodes the response with the one ofcoderswhose encoding matches the response'sContent-Encodingheader, without having to check its encoding first.encodeMessage(HttpRequest message) encodeMessage(HttpResponse message) static CoderReturns the enum constant of this class with the specified name.static Coder[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NoCoding
-
Deflate
-
Gzip
-
DeflateLevel1
-
DeflateLevel9
-
GzipLevel1
-
GzipLevel9
-
Zstd
The 'zstd' encoding, which needs the optionalcom.github.luben:zstd-jnidependency on the classpath.- Since:
- 2.0.0
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
encodeMessage
-
encodeMessage
-
decodeMessage
-
decodeMessage
-
decode
public CompletionStage<org.apache.pekko.util.ByteString> decode(org.apache.pekko.util.ByteString input, org.apache.pekko.stream.Materializer mat) -
_underlyingScalaCoder
-
decodeResponse
Decodes the response with the one ofcoderswhose encoding matches the response'sContent-Encodingheader, without having to check its encoding first. If no coders are given,Gzip,DeflateandNoCodingare used;Zstdhas to be given explicitly.The response is returned unchanged if it has no
Content-Encodingheader, if none ofcodersmatches its encoding, or if the header lists more than one encoding. In the last two cases theContent-Encodingheader is kept, soresponse.encoding()shows that the entity is still encoded.- Since:
- 2.0.0
-
decodeRequest
Decodes the request with the one ofcoderswhose encoding matches the request'sContent-Encodingheader, seedecodeResponse(HttpResponse, Coder...).- Since:
- 2.0.0
-