ent/entc/gen/predicate.go

// Copyright 2019-present Facebook Inc. All rights reserved.
// This source code is licensed under the Apache 2.0 license found
// in the LICENSE file in the root directory of this source tree.

package gen

// Op represents a predicate operation for schema fields.
type Op int

// List of all builtin predicates.
const (
	EQ           Op = iota // =
	NEQ                    // <>
	GT                     // >
	GTE                    // >=
	LT                     // <
	LTE                    // <=
	IsNil                  // IS NULL / has
	NotNil                 // IS NOT NULL / hasNot
	In                     // within
	NotIn                  // without
	EqualFold              // equals case-insensitive
	Contains               // containing
	ContainsFold           // containing case-insensitive
	HasPrefix              // startingWith
	HasSuffix              // endingWith
)

// Name returns the string representation of an operator.
func (o Op) Name() string {
	if int(o) < len(opText) {
		return opText[o]
	}
	return "Unknown"
}

// Variadic reports if the operator is a variadic function (takes a varying number of arguments).
func (o Op) Variadic() bool {
	return o == In || o == NotIn
}

// Niladic reports if the operator is niladic (takes no arguments).
func (o Op) Niladic() bool {
	return o == IsNil || o == NotNil
}

var (
	// operations text.
	opText = [...]string{
		EQ:           "EQ",
		NEQ:          "NEQ",
		GT:           "GT",
		GTE:          "GTE",
		LT:           "LT",
		LTE:          "LTE",
		IsNil:        "IsNil",
		NotNil:       "NotNil",
		EqualFold:    "EqualFold",
		Contains:     "Contains",
		ContainsFold: "ContainsFold",
		HasPrefix:    "HasPrefix",
		HasSuffix:    "HasSuffix",
		In:           "In",
		NotIn:        "NotIn",
	}
	// operations per type.
	boolOps     = []Op{EQ, NEQ}
	enumOps     = append(boolOps, In, NotIn)
	numericOps  = append(enumOps, GT, GTE, LT, LTE)
	stringOps   = append(numericOps, Contains, HasPrefix, HasSuffix)
	nillableOps = []Op{IsNil, NotNil}
)