Is your feature request related to a problem or challenge?
There are some flaws in documentation of the Expression API:
- Several operator overloads are implemented but not mentioned in the Expression API section.
- Bitwise operation methods of
Expr are not implemented as stated in the documentation. For example, bitwise_and(expr1, expr2) can also be expr1.bitwise_and(expr2) according to the document, but Expr::bitwise_and is not implemented.
- Bitwise XOR shoud be
^ in Bitwise Operators. It would be # in SQL but it does not work in rust. Additionally, I'm not sure if the fmt::Display impl of Operator::BitwiseXor is used elsewhere, but it returns "BIT_XOR".
Describe the solution you'd like
- Add a section on supported operators and rearranging sections (Boolean Expressions, Bitwise Expressions, Bitwise Operators) in the Expression API.
- The functions are already implemented, and they just need to be wired up. We can either add bitwise operations methods (
bitwise_and, bitwise_or, bitwise_xor, bitwise_shift_right, bitwise_shift_left) to Expr, and/or simply refer to its operator override functions and update the documentation accordingly.
- Replacing
# with ^ in the document. Maybe change "BIT_XOR" to "#" in the Display impl.
Describe alternatives you've considered
No response
Additional context
No response
Is your feature request related to a problem or challenge?
There are some flaws in documentation of the Expression API:
Exprare not implemented as stated in the documentation. For example,bitwise_and(expr1, expr2)can also beexpr1.bitwise_and(expr2)according to the document, butExpr::bitwise_andis not implemented.^in Bitwise Operators. It would be#in SQL but it does not work in rust. Additionally, I'm not sure if thefmt::Displayimpl ofOperator::BitwiseXoris used elsewhere, but it returns "BIT_XOR".Describe the solution you'd like
bitwise_and,bitwise_or,bitwise_xor,bitwise_shift_right,bitwise_shift_left) toExpr, and/or simply refer to its operator override functions and update the documentation accordingly.#with^in the document. Maybe change "BIT_XOR" to "#" in theDisplayimpl.Describe alternatives you've considered
No response
Additional context
No response