Enum data_encoding::BitOrder
source · pub enum BitOrder {
MostSignificantFirst,
LeastSignificantFirst,
}
Expand description
Order in which bits are read from a byte
The base-conversion encoding is always little-endian. This means that the least significant byte is always first. However, we can still choose whether, within a byte, this is the most significant or the least significant bit that is first. If the terminology is confusing, testing on an asymmetrical example should be enough to choose the correct value.
§Examples
In the following example, we can see that a base with the MostSignificantFirst
bit-order has
the most significant bit first in the encoded output. In particular, the output is in the same
order as the bits in the byte. The opposite happens with the LeastSignificantFirst
bit-order.
The least significant bit is first and the output is in the reverse order.
use data_encoding::{BitOrder, Specification};
let mut spec = Specification::new();
spec.symbols.push_str("01");
spec.bit_order = BitOrder::MostSignificantFirst; // default
let msb = spec.encoding().unwrap();
spec.bit_order = BitOrder::LeastSignificantFirst;
let lsb = spec.encoding().unwrap();
assert_eq!(msb.encode(&[0b01010011]), "01010011");
assert_eq!(lsb.encode(&[0b01010011]), "11001010");
Variants§
MostSignificantFirst
Most significant bit first
This is the most common and most intuitive bit-order. In particular, this is the bit-order used by RFC4648 and thus the usual hexadecimal, base64, base32, base64url, and base32hex encodings. This is the default bit-order when specifying a base.
LeastSignificantFirst
Trait Implementations§
impl Copy for BitOrder
impl Eq for BitOrder
impl StructuralPartialEq for BitOrder
Auto Trait Implementations§
impl Freeze for BitOrder
impl RefUnwindSafe for BitOrder
impl Send for BitOrder
impl Sync for BitOrder
impl Unpin for BitOrder
impl UnwindSafe for BitOrder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)