public sealed class BitSequence : IMessage<BitSequence>, IEquatable<BitSequence>, IDeepCloneable<BitSequence>, IBufferMessage, IMessage
Reference documentation and code samples for the Firestore v1 API class BitSequence.
A sequence of bits, encoded in a byte array.
Each byte in the bitmap byte array stores 8 bits of the sequence. The only
exception is the last byte, which may store 8 or fewer bits. The padding
defines the number of bits of the last byte to be ignored as "padding". The
values of these "padding" bits are unspecified and must be ignored.
To retrieve the first bit, bit 0, calculate: (bitmap[0] & 0x01) != 0.
To retrieve the second bit, bit 1, calculate: (bitmap[0] & 0x02) != 0.
To retrieve the third bit, bit 2, calculate: (bitmap[0] & 0x04) != 0.
To retrieve the fourth bit, bit 3, calculate: (bitmap[0] & 0x08) != 0.
To retrieve bit n, calculate: (bitmap[n / 8] & (0x01 << (n % 8))) != 0.
The "size" of a BitSequence (the number of bits it contains) is calculated
by this formula: (bitmap.length * 8) - padding.
The number of bits of the last byte in bitmap to ignore as "padding".
If the length of bitmap is zero, then this value must be 0.
Otherwise, this value must be between 0 and 7, inclusive.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the \u003ccode\u003eBitSequence\u003c/code\u003e class within the Google Cloud Firestore V1 API, focusing on its structure and usage.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eBitSequence\u003c/code\u003e represents a sequence of bits encoded in a byte array, where each byte can store up to 8 bits, with potential padding in the last byte.\u003c/p\u003e\n"],["\u003cp\u003eThe class includes properties \u003ccode\u003eBitmap\u003c/code\u003e (a byte array encoding the bits) and \u003ccode\u003ePadding\u003c/code\u003e (specifying the number of padding bits in the last byte).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eBitSequence\u003c/code\u003e class implements multiple interfaces, such as \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, \u003ccode\u003eIBufferMessage\u003c/code\u003e, and \u003ccode\u003eIMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe page also provides links to various versions of the Google Cloud Firestore V1 API documentation, ranging from version 2.3.0 to the latest version 3.10.0.\u003c/p\u003e\n"]]],[],null,[]]
