filter

Documentation

Overview

Package filter implements a collections of matchers for accepting or rejecting messages based on some simple structural rules.

1. Partial-Literal matching The main mode of operation is to match specified literals, so if we get the filter expression like: {"foo": "bar"} then it will match maps with that shape. e.g. {"foo": "bar", "baz": true} Note that this can only prefix-match arrays, see [anything].

2. Exact-Literal matching This would kick in when we are passed a pattern with the shape: {"[exact]": {"foo": "bar"}} The result would be something very similar to #1, however, we would not accept the unspecified "baz" key. This applies to exactly one level of the object.

3. One Of matching This would kick in when we are passed a pattern with the shape: {"[oneof]": [{"foo": "bar"}, {"baz": "blah"}]}

4. Match Anything This would kick in when we are passed a pattern with the shape: [anything] The idea is to allow folks to blank out values in partial literal matching of arrays, or require a key without specifying the value. e.g. {"foo": ["bar", "[anything]", "baz"]} e.g. {"foo": "[anything]"}

5. TODO(mattmoor): Regexp Match

Index

• type Matcher
  • func Compile(pattern interface{}) (Matcher, error)

Types

type Matcher

type Matcher interface {
	Match(interface{}) bool
}

func Compile

func Compile(pattern interface{}) (Matcher, error)