summaryrefslogtreecommitdiff
path: root/modules/caddyhttp/matchers.go
diff options
context:
space:
mode:
authorMatthew Holt <mholt@users.noreply.github.com>2020-02-14 11:00:46 -0700
committerMatthew Holt <mholt@users.noreply.github.com>2020-02-14 11:01:09 -0700
commit2cc5d2227dd8b8ad2d71112709ec29ab34fcd0ea (patch)
tree23756a2e0daa636b7d9ed9fcc61c42242f5382f1 /modules/caddyhttp/matchers.go
parent15bf9c196c5972051f40ebadf50811bd06e328dd (diff)
Minor tweaks to docs/comments
Diffstat (limited to 'modules/caddyhttp/matchers.go')
-rw-r--r--modules/caddyhttp/matchers.go7
1 files changed, 6 insertions, 1 deletions
diff --git a/modules/caddyhttp/matchers.go b/modules/caddyhttp/matchers.go
index 552aa91..3b890d9 100644
--- a/modules/caddyhttp/matchers.go
+++ b/modules/caddyhttp/matchers.go
@@ -72,7 +72,12 @@ type (
// MatchQuery matches requests by URI's query string.
MatchQuery url.Values
- // MatchHeader matches requests by header fields.
+ // MatchHeader matches requests by header fields. It performs fast,
+ // exact string comparisons of the field values. Fast prefix, suffix,
+ // and substring matches can also be done by suffixing, prefixing, or
+ // surrounding the value with the wildcard `*` character, respectively.
+ // If a list is null, the header must not exist. If the list is empty,
+ // the field must simply exist, regardless of its value.
MatchHeader http.Header
// MatchHeaderRE matches requests by a regular expression on header fields.