MutableHeaders class final
The builder side of Headers, a MutableHeaderStore with typed reads and writes.
Write a typed header with its setter or with assign, and any header
by name with []=. Every write rejects a value with CR, LF or NUL, so
nothing reaches the wire that would end the field.
- Inheritance
-
- Object
- HeaderStore
- MutableHeaderStore
- MutableHeaders
- Mixed-in types
- Available extensions
Constructors
Properties
- accept ↔ AcceptHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - accept → AcceptHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - acceptEncoding → AcceptEncodingHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - acceptEncoding ↔ AcceptEncodingHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - acceptLanguage → AcceptLanguageHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - acceptLanguage ↔ AcceptLanguageHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - acceptRanges → AcceptRangesHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - acceptRanges ↔ AcceptRangesHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - accessControlAllowCredentials ↔ bool?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - accessControlAllowCredentials → bool?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - accessControlAllowHeaders ↔ AccessControlAllowHeadersHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - accessControlAllowHeaders → AccessControlAllowHeadersHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - accessControlAllowMethods ↔ AccessControlAllowMethodsHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - accessControlAllowMethods → AccessControlAllowMethodsHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - accessControlAllowOrigin → AccessControlAllowOriginHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - accessControlAllowOrigin ↔ AccessControlAllowOriginHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - accessControlExposeHeaders ↔ AccessControlExposeHeadersHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - accessControlExposeHeaders → AccessControlExposeHeadersHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - accessControlMaxAge ↔ int?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - accessControlMaxAge → int?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter -
accessControlRequestHeaders
→ List<
String> ? -
Available on HeaderValues, provided by the HeadersEx extension
no setter -
accessControlRequestHeaders
↔ List<
String> ? -
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - accessControlRequestMethod → Method?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - accessControlRequestMethod ↔ Method?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - age ↔ int?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - age → int?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter -
allow
↔ Set<
Method> ? -
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair -
allow
→ Set<
Method> ? -
Available on HeaderValues, provided by the HeadersEx extension
no setter -
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair -
Available on HeaderValues, provided by the HeadersEx extension
no setter - cacheControl ↔ CacheControlHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - cacheControl → CacheControlHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - clearSiteData → ClearSiteDataHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - clearSiteData ↔ ClearSiteDataHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - connection ↔ ConnectionHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - connection → ConnectionHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - contentDisposition → ContentDispositionHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - contentDisposition ↔ ContentDispositionHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - contentEncoding → ContentEncodingHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - contentEncoding ↔ ContentEncodingHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - contentLanguage → ContentLanguageHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - contentLanguage ↔ ContentLanguageHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - contentLength ↔ int?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - contentLength → int?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - contentLocation → Uri?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - contentLocation ↔ Uri?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - contentRange → ContentRangeHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - contentRange ↔ ContentRangeHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - contentSecurityPolicy → ContentSecurityPolicyHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - contentSecurityPolicy ↔ ContentSecurityPolicyHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - contentType → ContentTypeHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
The parsed Content-Type header.no setter - contentType → ContentTypeHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
The parsed Content-Type header.no setter -
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair -
Available on HeaderValues, provided by the HeadersEx extension
no setter - crossOriginEmbedderPolicy → CrossOriginEmbedderPolicyHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - crossOriginEmbedderPolicy ↔ CrossOriginEmbedderPolicyHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - crossOriginOpenerPolicy → CrossOriginOpenerPolicyHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - crossOriginOpenerPolicy ↔ CrossOriginOpenerPolicyHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - crossOriginResourcePolicy ↔ CrossOriginResourcePolicyHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - crossOriginResourcePolicy → CrossOriginResourcePolicyHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - date → DateTime?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - date ↔ DateTime?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - etag ↔ ETagHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - etag → ETagHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - expect → ExpectHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - expect ↔ ExpectHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - expires → DateTime?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - expires ↔ DateTime?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - fieldCount → int
-
The number of name and value pairs.
no setterinherited
- forwarded ↔ ForwardedHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - forwarded → ForwardedHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - from → FromHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - from ↔ FromHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - hashCode → int
-
The hash code for this object.
no setterinherited
- host → HostHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - host ↔ HostHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - ifMatch ↔ IfMatchHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - ifMatch → IfMatchHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - ifModifiedSince → DateTime?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - ifModifiedSince ↔ DateTime?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - ifNoneMatch → IfNoneMatchHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - ifNoneMatch ↔ IfNoneMatchHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - ifRange ↔ IfRangeHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - ifRange → IfRangeHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - ifUnmodifiedSince ↔ DateTime?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - ifUnmodifiedSince → DateTime?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - isEmpty → bool
-
no setterinherited
- isNotEmpty → bool
-
no setterinherited
- lastModified ↔ DateTime?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - lastModified → DateTime?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - location → Uri?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - location ↔ Uri?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - maxForwards → int?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - maxForwards ↔ int?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair -
names
→ Iterable<
HeaderName> -
Every distinct name, in the order it first appears.
no setterinherited
- origin → Uri?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - origin ↔ Uri?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - permissionsPolicy → PermissionsPolicyHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - permissionsPolicy ↔ PermissionsPolicyHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - proxyAuthenticate → AuthenticationHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - proxyAuthenticate ↔ AuthenticationHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - proxyAuthorization ↔ AuthorizationHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - proxyAuthorization → AuthorizationHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - range ↔ RangeHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - range → RangeHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - referer ↔ Uri?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - referer → Uri?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - referrerPolicy → ReferrerPolicyHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - referrerPolicy ↔ ReferrerPolicyHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - retryAfter → RetryAfterHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - retryAfter ↔ RetryAfterHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- secFetchDest → SecFetchDestHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - secFetchDest ↔ SecFetchDestHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - secFetchMode → SecFetchModeHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - secFetchMode ↔ SecFetchModeHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - secFetchSite ↔ SecFetchSiteHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - secFetchSite → SecFetchSiteHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - server → String?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - server ↔ String?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - setCookie → SetCookieHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - setCookie ↔ SetCookieHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - strictTransportSecurity ↔ StrictTransportSecurityHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - strictTransportSecurity → StrictTransportSecurityHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - te → TEHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - te ↔ TEHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair -
trailer
↔ List<
String> ? -
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair -
trailer
→ List<
String> ? -
Available on HeaderValues, provided by the HeadersEx extension
no setter - transferEncoding ↔ TransferEncodingHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - transferEncoding → TransferEncodingHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - upgrade → UpgradeHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - upgrade ↔ UpgradeHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - userAgent → String?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - userAgent ↔ String?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - vary ↔ VaryHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - vary → VaryHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter -
via
→ List<
String> ? -
Available on HeaderValues, provided by the HeadersEx extension
no setter -
via
↔ List<
String> ? -
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - wwwAuthenticate → AuthenticationHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - wwwAuthenticate ↔ AuthenticationHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - xForwardedFor → XForwardedForHeader?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - xForwardedFor ↔ XForwardedForHeader?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair - xPoweredBy → String?
-
Available on HeaderValues, provided by the HeadersEx extension
no setter - xPoweredBy ↔ String?
-
Available on MutableHeaders, provided by the MutableHeadersEx extension
getter/setter pair
Methods
-
add(
HeaderName name, String value) → void -
Appends
valueto the values forname.override -
adoptCache(
AccessorStateMixin< HeaderName, Iterable< other) → voidString> > -
Copies every decoded value
otherholds into this cache.inherited -
assign<
T extends Object> (HeaderAccessor< T> accessor, T? value) → void -
Sets
accessortovalue, or removes it whenvalueis null. -
call<
T extends Object> (ReadOnlyAccessor< T, HeaderName, Iterable< accessor) → T?String> > -
Decodes from the wire bytes when the accessor's codec can and the store
is a ByteHeaderSource, else from the text.
inherited
-
clear(
) → void -
override
-
contains(
HeaderName name) → bool -
inherited
-
decodeCached<
T extends Object> (ReadOnlyAccessor< T, HeaderName, Iterable< accessor, Object raw, T decode()) → TString> > -
The value
decodeproduces foraccessorfromraw, decoded once per (accessor, raw) pair.inherited -
forEach(
void visit(HeaderName name, String value)) → void -
Visits every name and value pair, in order.
inherited
-
get<
T extends Object> (ReadOnlyAccessor< T, HeaderName, Iterable< accessor) → TString> > -
The decoded value for
accessor.inherited -
lookup(
HeaderName key) → Iterable< String> ? -
The raw value for
key, or null when absent.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
prime<
T extends Object> (ReadOnlyAccessor< T, HeaderName, Iterable< accessor, Object raw, T value) → voidString> > -
Records
valueas the decoded form ofrawforaccessor.inherited -
remove(
Object key) → void -
Removes the header called
key, which may be a HeaderName, a name as text, or an accessor.override -
set(
HeaderName name, Iterable< String> values) → void -
Replaces every value for
namewithvalues, or removes the field whenvaluesis empty.override -
toMap(
) → Map< String, List< String> > -
The fields as a map from lowercase name to values.
inherited
-
toMutable(
) → MutableHeaderStore -
A MapHeaderStore with this store's fields.
inherited
-
toString(
) → String -
A string representation of this object.
override
-
tryGet<
T extends Object> (ReadOnlyAccessor< T, HeaderName, Iterable< accessor) → T?String> > -
Returns the decoded value for the given
accessor, ornullif missing or if decoding fails.inherited -
value(
HeaderName name) → String? -
The first value for
name, or null.inherited -
values(
HeaderName name) → Iterable< String> -
Every value for
name, in order, or empty whennameis absent.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
Object key) → Iterable< String> ? -
The raw values for
key, a HeaderName, a name as text, or an accessor.inherited -
operator []=(
Object key, Iterable< String> ? values) → void -
Sets the header called
key, a HeaderName or a name as text, or removes it whenvaluesis null.