treecmp

Documentation

Overview

Package treecmp contains the implementation-agnostic information about all comparison operators that we support.

Index

• func ComparisonOpName(op ComparisonOperatorSymbol) string
• type ComparisonOperator
  • func MakeComparisonOperator(symbol ComparisonOperatorSymbol) ComparisonOperator
  • func (ComparisonOperator) Operator()
  • func (o ComparisonOperator) String() string
• type ComparisonOperatorSymbol
  • func (i ComparisonOperatorSymbol) HasSubOperator() bool
  • func (i ComparisonOperatorSymbol) String() string

Functions

func ComparisonOpName

func ComparisonOpName(op ComparisonOperatorSymbol) string

ComparisonOpName returns the name of op.

Types

type ComparisonOperator

type ComparisonOperator struct {
	Symbol ComparisonOperatorSymbol
	// IsExplicitOperator is true if OPERATOR(symbol) is used.
	IsExplicitOperator bool
}

ComparisonOperator represents a binary operator which returns a bool.

func MakeComparisonOperator

func MakeComparisonOperator(symbol ComparisonOperatorSymbol) ComparisonOperator

MakeComparisonOperator creates a ComparisonOperator given a symbol.

func (ComparisonOperator) Operator

func (ComparisonOperator) Operator()

Operator implements tree.Operator.

func (ComparisonOperator) String

func (o ComparisonOperator) String() string

type ComparisonOperatorSymbol

type ComparisonOperatorSymbol int

ComparisonOperatorSymbol represents a comparison operator symbol.

const (
	EQ ComparisonOperatorSymbol = iota
	LT
	GT
	LE
	GE
	NE
	In
	NotIn
	Like
	NotLike
	ILike
	NotILike
	SimilarTo
	NotSimilarTo
	RegMatch
	NotRegMatch
	RegIMatch
	NotRegIMatch
	IsDistinctFrom
	IsNotDistinctFrom
	Contains
	ContainedBy
	JSONExists
	JSONSomeExists
	JSONAllExists
	Overlaps
	TSMatches

	// The following operators will always be used with an associated SubOperator.
	// If Go had algebraic data types they would be defined in a self-contained
	// manner like:
	//
	// Any(ComparisonOperator)
	// Some(ComparisonOperator)
	// ...
	//
	// where the internal ComparisonOperator qualifies the behavior of the primary
	// operator. Instead, a secondary ComparisonOperator is optionally included in
	// ComparisonExpr for the cases where these operators are the primary op.
	//
	// ComparisonOperator.HasSubOperator returns true for ops in this group.
	Any
	Some
	All

	NumComparisonOperatorSymbols
)

ComparisonExpr.Operator

func (ComparisonOperatorSymbol) HasSubOperator

func (i ComparisonOperatorSymbol) HasSubOperator() bool

HasSubOperator returns if the ComparisonOperator is used with a sub-operator.

func (ComparisonOperatorSymbol) String

func (i ComparisonOperatorSymbol) String() string