Skip to content

Commit fc9c45d

Browse files
committed
Modify module docs to explain that big endian is not supported.
1 parent c143f4f commit fc9c45d

2 files changed

Lines changed: 5 additions & 2 deletions

File tree

crates/geo_filters/src/diff_count/bitvec.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,6 @@ impl BitVec<'_> {
189189

190190
// First serialize the number of unoccupied bits in the last block as one byte.
191191
let unoccupied_bits = 63 - ((self.num_bits - 1) % 64) as u8;
192-
193192
writer.write_all(&[unoccupied_bits])?;
194193

195194
let blocks = self.blocks.deref();

crates/geo_filters/src/diff_count/serde.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@
55
//! to the usual "network endian" approach where big endian is the default, but most of our
66
//! consumers are little endian so it makes sense for this to be the optimal approach.
77
//!
8-
//! We still need to support big endian platforms though, but they get a less efficient path.
8+
//! For now we do not support big endian platforms. In the future we might add a big endian
9+
//! platform specific implementation which is able to read the little endian serialized
10+
//! representation. For now, if you attempt to serialize a filter on a big endian platform
11+
//! you get a panic.
12+
913
use std::{borrow::Cow, ops::Deref as _};
1014

1115
use crate::{config::GeoConfig, Diff};

0 commit comments

Comments
 (0)