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\u003eThe latest version available for the BitSequence class in the Firestore v1 API is 3.10.0, with version 3.9.0 being the one currently displayed in the documentation.\u003c/p\u003e\n"],["\u003cp\u003eThe BitSequence class, found within the Google.Cloud.Firestore.V1 namespace, represents a sequence of bits stored within a byte array.\u003c/p\u003e\n"],["\u003cp\u003eEach byte within the \u003ccode\u003ebitmap\u003c/code\u003e array encodes 8 bits, with the exception of the final byte which may contain 8 or fewer bits, and any unused bits in the last byte are defined as padding.\u003c/p\u003e\n"],["\u003cp\u003eThe size of a BitSequence is determined by multiplying the length of the bitmap by 8 and then subtracting the padding value, as shown in the formula \u003ccode\u003e(bitmap.length * 8) - padding\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eBitSequence implements interfaces such as IMessage, IEquatable, IDeepCloneable, and IBufferMessage, also having a couple of constructors, one that is empty and another that accepts another BitSequence.\u003c/p\u003e\n"]]],[],null,[]]
