package
0.5.1
Repository: https://github.com/calebjh/atlas-app-toolkit.git
Documentation: pkg.go.dev

# Functions

Filter is a shortcut to parse a filter string using default FilteringParser implementation and call Filter on the returned filtering expression.
NewFilteringLexer returns a default FilteringLexer implementation.
NewFilteringParser returns a default FilteringParser implementation.
ParseFieldSelection transforms a string with comma-separated fields that comesfrom client to FieldSelection struct.
ParseFiltering is a shortcut to parse a filtering expression using default FilteringParser implementation.
Pagination parses string representation of pagination limit, offset.
ParseSorting parses raw string that represent sort criteria into a Sorting data structure.

# Constants

Default pagination limit.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ascending sort order.
descending sort order.
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

AndToken represents logical and.
EOFToken represents end of an expression.
EqToken represents equals operator.
Field represents a single field for an object.
FieldSelection represents a group of fields for some object.
FieldToken represents a reference to a value of a resource.
Filtering represents filtering expression.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GeToken represents greater than or equals operator.
GtToken represents greater than operator.
LeToken represents less than or equals operator.
LogicalOperator represents binary logical operator, either AND or OR depending on type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
LparenToken represents left parenthesis.
LtToken represents less than operator.
MatchToken represents regular expression match.
NeToken represents not equals operator.
NmatchToken represents negation of regular expression match.
NotToken represents logical not.
NullCondition represents a condition with a null literal, e.g.
NullToken represents null literal.
NumberCondition represents a condition with a number literal, e.g.
NumberToken represents a number literal.
OrToken represents logical or.
PageInfo represents both server-driven and client-driven pagination response.
Pagination represents both server-driven and client-driven pagination request.
RparenToken represents right parenthesis.
SortCriteria represents sort criteria.
Sorting represents list of sort criterias.
StringCondition represents a condition with a string literal, e.g.
StringToken represents a string literal.
TokenBase is used as a base type for all types which are tokens.
TypeMismatchError representes a type that is required for a value under FieldPath.
UnexpectedSymbolError describes symbol S in position Pos that was not appropriate according to REST API Syntax Specification.
UnexpectedTokenError describes a token that was not appropriate according to REST API Syntax Specification.
UnsupportedOperatorError represents an operator that is not supported by a particular field type.

# Interfaces

FilteringExpression is the interface implemented by types that represent nodes in a filtering expression AST.
FilteringLexer is impemented by lexical analyzers that are used by filtering expression parsers.
FilteringParser is implemented by parsers of a filtering expression that conforms to REST API Syntax Specification.
Matcher is implemented by structs that require custom filtering logic.
Token is impelemented by all supported tokens in a filtering expression.

# Type aliases

FieldSelectionMap is a convenience type that represents map[string]*Fieldused in FieldSelection and Field structs.
No description provided by the author
No description provided by the author
Order is a sort order.
No description provided by the author