libs/luci-lib-nixio/docsrc/nixio.bit.lua

   1 --- Bitfield operators and mainpulation functions.
   2 -- Can be used as a drop-in replacement for bitlib.
   3 module "nixio.bit"
   4
   5 --- Bitwise OR several numbers.
   6 -- @class function
   7 -- @name bor
   8 -- @param oper1 First Operand
   9 -- @param oper2 Second Operand
  10 -- @param ...   More Operands
  11 -- @return number
  12
  13 --- Invert given number.
  14 -- @class function
  15 -- @name bnot
  16 -- @param oper Operand
  17 -- @return number
  18
  19 --- Bitwise AND several numbers.
  20 -- @class function
  21 -- @name band
  22 -- @param oper1 First Operand
  23 -- @param oper2 Second Operand
  24 -- @param ...   More Operands
  25 -- @return number
  26
  27 --- Bitwise XOR several numbers.
  28 -- @class function
  29 -- @name bxor
  30 -- @param oper1 First Operand
  31 -- @param oper2 Second Operand
  32 -- @param ...   More Operands
  33 -- @return number
  34
  35 --- Left shift a number.
  36 -- @class function
  37 -- @name lshift
  38 -- @param oper  number
  39 -- @param shift bits to shift
  40 -- @return number
  41
  42 --- Right shift a number.
  43 -- @class function
  44 -- @name rshift
  45 -- @param oper  number
  46 -- @param shift bits to shift
  47 -- @return number
  48
  49 --- Arithmetically right shift a number.
  50 -- @class function
  51 -- @name arshift
  52 -- @param oper  number
  53 -- @param shift bits to shift
  54 -- @return number
  55
  56 --- Integer division of 2 or more numbers.
  57 -- @class function
  58 -- @name div
  59 -- @param oper1 Operand 1
  60 -- @param oper2 Operand 2
  61 -- @param ... More Operands
  62 -- @return number
  63
  64 --- Cast a number to the bit-operating range.
  65 -- @class function
  66 -- @name cast
  67 -- @param oper  number
  68 -- @return number
  69
  70 --- Sets one or more flags of a bitfield.
  71 -- @class function
  72 -- @name set
  73 -- @param bitfield      Bitfield
  74 -- @param flag1 First Flag
  75 -- @param ...   More Flags
  76 -- @return altered bitfield
  77
  78 --- Unsets one or more flags of a bitfield.
  79 -- @class function
  80 -- @name unset
  81 -- @param bitfield      Bitfield
  82 -- @param flag1 First Flag
  83 -- @param ...   More Flags
  84 -- @return altered bitfield
  85
  86 --- Checks whether given flags are set in a bitfield.
  87 -- @class function
  88 -- @name check
  89 -- @param bitfield      Bitfield
  90 -- @param flag1 First Flag
  91 -- @param ...   More Flags
  92 -- @return true when all flags are set, otherwise false