Module jsxd_filter

.

Copyright © (C) 2016, Heinz Nikolaus Gies

Authors: Heinz Nikolaus Gies (heinz@licenser.net).

Description

Data Types

filter()

filter() = {matcher(), path(), term()} | {defined, path()}

filters()

filters() = filter() | {'not', filters()} | {'or', filters(), filters()} | [filter()]

matcher()

matcher() = '==' | '>=' | '=<' | '>' | '<' | '~='

path()

path() = binary() | [binary() | integer()]

Function Index

deserialize/1Deserializes a filter from the binary format to a structure.
filter/2Tests a object against a given filter, returns either true or false.
serialize/1Serializes a filter to a binary format for sending and storing.

Function Details

deserialize/1

deserialize(X1::binary()) -> filters() | filter()

Deserializes a filter from the binary format to a structure.

filter/2

filter(O::#{}, R::filters()) -> boolean()

Tests a object against a given filter, returns either true or false.

serialize/1

serialize(Es::filters() | filter()) -> binary()

Serializes a filter to a binary format for sending and storing


Generated by EDoc, Sep 20 2016, 06:40:55.