Return the position of the first bit set to 1 or 0 in a string.
The position is returned, thinking of the string as an array of bits from left to right, where the first byte's most significant bit is at position 0, the second byte's most significant bit is at position 8, and so forth.
By default, all the bytes contained in the string are examined.
It is possible to look for bits only in a specified interval passing the additional arguments start and end (it is possible to just pass start, the operation will assume that the end is the last byte of the string. However there are semantic differences as explained later).
By default, the range is interpreted as a range of bytes and not a range of bits, so
end=2 means to look at the first three bytes.
You can use the optional
BIT modifier to specify that the range should be interpreted as a range of bits.
end=2 means to look at the first three bits.
Note that bit positions are returned always as absolute values starting from bit zero even when start and end are used to specify a range.
Like for the GETRANGE command start and end can contain negative values in
order to index bytes starting from the end of the string, where -1 is the last
byte, -2 is the penultimate, and so forth. When
BIT is specified, -1 is the last
bit, -2 is the penultimate, and so forth.
Non-existent keys are treated as empty strings.
The command returns the position of the first bit set to 1 or 0 according to the request.
If we look for set bits (the bit argument is 1) and the string is empty or composed of just zero bytes, -1 is returned.
If we look for clear bits (the bit argument is 0) and the string only contains bit set to 1, the function returns the first bit not part of the string on the right. So if the string is three bytes set to the value
0xff the command
BITPOS key 0 will return 24, since up to bit 23 all the bits are 1.
Basically, the function considers the right of the string as padded with zeros if you look for clear bits and specify no range or the start argument only.
However, this behavior changes if you are looking for clear bits and specify a range with both start and end. If no clear bit is found in the specified range, the function returns -1 as the user specified a clear range and there are no 0 bits in that range.
"OK"redis> BITPOS mykey 0
(integer) 12redis> SET mykey "\x00\xff\xf0"
"OK"redis> BITPOS mykey 1 0
(integer) 8redis> BITPOS mykey 1 2
(integer) 16redis> BITPOS mykey 1 2 -1 BYTE
ERR ERR syntax errorredis> BITPOS mykey 1 7 15 BIT
ERR ERR syntax errorredis> set mykey "\x00\x00\x00"
"OK"redis> BITPOS mykey 1
(integer) -1redis> BITPOS mykey 1 7 -3 BIT
ERR ERR syntax error
- Redis version >= 7.0.0: Added the `BYTE|BIT` option.