object HttpHeader
- Source
- HttpHeader.scala
- Alphabetic
- By Inheritance
- HttpHeader
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- sealed trait ParsingResult extends AnyRef
Value Members
- def parse(name: String, value: String, settings: Settings = HeaderParser.DefaultSettings): ParsingResult
Attempts to parse the given header name and value string into a header model instance.
Attempts to parse the given header name and value string into a header model instance.
This process has several possible outcomes:
1. The header name corresponds to a properly modelled header and a) the value is valid for this header type. In this case the method returns a
ParsingResult.Ok
with the respective header instance and no errors. b) the value consists of a number elements, some of which valid and some invalid, and the header type supports partial value parsing. In this case the method returns aParsingResult.Ok
with the respective header instance holding the valid value elements and an ErrorInfo for each invalid value. c) the value has invalid elements and the header type doesn't support partial value parsing. In this case the method returns aParsingResult.Ok
with a akka.http.scaladsl.model.headers.RawHeader instance and a single ErrorInfo for the value parsing problem.2. The header name does not correspond to a properly modelled header but the header name and the value are both syntactically legal according to the basic header requirements from the HTTP specification. (http://tools.ietf.org/html/rfc7230#section-3.2) In this case the method returns a
ParsingResult.Ok
with a akka.http.scaladsl.model.headers.RawHeader instance and no errors.3. The header name or value are illegal according to the basic requirements for HTTP headers (http://tools.ietf.org/html/rfc7230#section-3.2). In this case the method returns a
ParsingResult.Error
. - def unapply(header: HttpHeader): Option[(String, String)]
Extract name and value from a header.
Extract name and value from a header. CAUTION: The name must be matched in *all-lowercase*!.
- object ParsingResult