Struct Be

Source

#[repr(transparent)]
pub struct Be<T>(pub T);

Expand description

An integer stored in big-endian byte order.

§Examples

use endian_num::Be;

let n = 0x1Au32;

if cfg!(target_endian = "big") {
    assert_eq!(Be::<u32>::from_ne(n).0, n);
} else {
    assert_eq!(Be::<u32>::from_ne(n).0, n.swap_bytes());
}

pub const fn from_ne(n: u8) -> Self

Creates a new big-endian integer from a native-endian integer.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au8;

if cfg!(target_endian = "big") {
    assert_eq!(Be::<u8>::from_ne(n).0, n);
} else {
    assert_eq!(Be::<u8>::from_ne(n).0, n.swap_bytes());
}

Source

pub const fn from_le(n: Le<u8>) -> Self

Creates a new big-endian integer from a little-endian integer.

This always swaps the bytes.

§Examples

use endian_num::{Be, Le};

let n = 0x1Au8;

assert_eq!(Be::<u8>::from_le(Le(n)).0, n.swap_bytes());

Source

pub const fn to_ne(self) -> u8

Returns the integer in native-endian byte order.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au8;

if cfg!(target_endian = "big") {
    assert_eq!(Be(n).to_ne(), n);
} else {
    assert_eq!(Be(n).to_ne(), n.swap_bytes());
}

Source

pub const fn to_le(self) -> Le<u8>

Returns the integer in little-endian byte order.

This always swaps the bytes.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au8;

assert_eq!(Be(n).to_le().0, n.swap_bytes());

Source

pub const fn to_be_bytes(self) -> [u8; 1]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

§Examples

use endian_num::Be;

let bytes = Be::<u8>::from_ne(0x12).to_be_bytes();
assert_eq!(bytes, [0x12]);

Source

pub const fn to_le_bytes(self) -> [u8; 1]

Return the memory representation of this integer as a byte array in little-endian byte order.

§Examples

use endian_num::Be;

let bytes = Be::<u8>::from_ne(0x12).to_le_bytes();
assert_eq!(bytes, [0x12]);

Source

pub const fn to_ne_bytes(self) -> [u8; 1]

Return the memory representation of this integer as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

§Examples

use endian_num::Be;

let bytes = Be::<u8>::from_ne(0x12).to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12]
    } else {
        [0x12]
    }
);

Source

pub const fn from_be_bytes(bytes: [u8; 1]) -> Self

Create a big endian integer value from its representation as a byte array in big endian.

§Examples

use endian_num::Be;

let value = Be::<u8>::from_be_bytes([0x12]);
assert_eq!(value.to_ne(), 0x12);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_be_u8(input: &mut &[u8]) -> Be<u8> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u8>>());
    *input = rest;
    Be::<u8>::from_be_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_le_bytes(bytes: [u8; 1]) -> Self

Create a big endian integer value from its representation as a byte array in little endian.

§Examples

use endian_num::Be;

let value = Be::<u8>::from_le_bytes([0x12]);
assert_eq!(value.to_ne(), 0x12);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_le_u8(input: &mut &[u8]) -> Be<u8> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u8>>());
    *input = rest;
    Be::<u8>::from_le_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_ne_bytes(bytes: [u8; 1]) -> Self

Create a big endian integer value from its memory representation as a byte array in native endianness.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

§Examples

use endian_num::Be;

let value = Be::<u8>::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12]
} else {
    [0x12]
});
assert_eq!(value.to_ne(), 0x12);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_ne_u8(input: &mut &[u8]) -> Be<u8> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u8>>());
    *input = rest;
    Be::<u8>::from_ne_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u8>::from_ne(0x82);
let m = Be::<u8>::from_ne(0xa);

assert_eq!(n.rotate_left(2), m);

Source

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u8>::from_ne(0xa);
let m = Be::<u8>::from_ne(0x82);

assert_eq!(n.rotate_right(2), m);

Source

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x12u8);
let m = n.swap_bytes();

assert_eq!(m, Be(0x12));

Source

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer.

The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x12u8);
let m = n.reverse_bits();

assert_eq!(m, Be(0x48));
assert_eq!(Be(0), Be(0u8).reverse_bits());

Source

pub const fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<u8>::from_ne(2).pow(5).to_ne(), 32);

Basic usage:

use endian_num::Be;

assert_eq!(Be::<u16>::BITS, u16::BITS);

Source

pub const fn from_ne(n: u16) -> Self

Creates a new big-endian integer from a native-endian integer.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au16;

if cfg!(target_endian = "big") {
    assert_eq!(Be::<u16>::from_ne(n).0, n);
} else {
    assert_eq!(Be::<u16>::from_ne(n).0, n.swap_bytes());
}

Source

pub const fn from_le(n: Le<u16>) -> Self

Creates a new big-endian integer from a little-endian integer.

This always swaps the bytes.

§Examples

use endian_num::{Be, Le};

let n = 0x1Au16;

assert_eq!(Be::<u16>::from_le(Le(n)).0, n.swap_bytes());

Source

pub const fn to_ne(self) -> u16

Returns the integer in native-endian byte order.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au16;

if cfg!(target_endian = "big") {
    assert_eq!(Be(n).to_ne(), n);
} else {
    assert_eq!(Be(n).to_ne(), n.swap_bytes());
}

Source

pub const fn to_le(self) -> Le<u16>

Returns the integer in little-endian byte order.

This always swaps the bytes.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au16;

assert_eq!(Be(n).to_le().0, n.swap_bytes());

Source

pub const fn to_be_bytes(self) -> [u8; 2]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

§Examples

use endian_num::Be;

let bytes = Be::<u16>::from_ne(0x1234).to_be_bytes();
assert_eq!(bytes, [0x12, 0x34]);

Source

pub const fn to_le_bytes(self) -> [u8; 2]

Return the memory representation of this integer as a byte array in little-endian byte order.

§Examples

use endian_num::Be;

let bytes = Be::<u16>::from_ne(0x1234).to_le_bytes();
assert_eq!(bytes, [0x34, 0x12]);

Source

pub const fn to_ne_bytes(self) -> [u8; 2]

Return the memory representation of this integer as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

§Examples

use endian_num::Be;

let bytes = Be::<u16>::from_ne(0x1234).to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12, 0x34]
    } else {
        [0x34, 0x12]
    }
);

Source

pub const fn from_be_bytes(bytes: [u8; 2]) -> Self

Create a big endian integer value from its representation as a byte array in big endian.

§Examples

use endian_num::Be;

let value = Be::<u16>::from_be_bytes([0x12, 0x34]);
assert_eq!(value.to_ne(), 0x1234);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_be_u16(input: &mut &[u8]) -> Be<u16> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u16>>());
    *input = rest;
    Be::<u16>::from_be_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_le_bytes(bytes: [u8; 2]) -> Self

Create a big endian integer value from its representation as a byte array in little endian.

§Examples

use endian_num::Be;

let value = Be::<u16>::from_le_bytes([0x34, 0x12]);
assert_eq!(value.to_ne(), 0x1234);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_le_u16(input: &mut &[u8]) -> Be<u16> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u16>>());
    *input = rest;
    Be::<u16>::from_le_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_ne_bytes(bytes: [u8; 2]) -> Self

Create a big endian integer value from its memory representation as a byte array in native endianness.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

§Examples

use endian_num::Be;

let value = Be::<u16>::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12, 0x34]
} else {
    [0x34, 0x12]
});
assert_eq!(value.to_ne(), 0x1234);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_ne_u16(input: &mut &[u8]) -> Be<u16> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u16>>());
    *input = rest;
    Be::<u16>::from_ne_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u16>::from_ne(0xa003);
let m = Be::<u16>::from_ne(0x3a);

assert_eq!(n.rotate_left(4), m);

Source

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u16>::from_ne(0x3a);
let m = Be::<u16>::from_ne(0xa003);

assert_eq!(n.rotate_right(4), m);

Source

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x1234u16);
let m = n.swap_bytes();

assert_eq!(m, Be(0x3412));

Source

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer.

The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x1234u16);
let m = n.reverse_bits();

assert_eq!(m, Be(0x2c48));
assert_eq!(Be(0), Be(0u16).reverse_bits());

Source

pub const fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<u16>::from_ne(2).pow(5).to_ne(), 32);

Basic usage:

use endian_num::Be;

assert_eq!(Be::<u32>::BITS, u32::BITS);

Source

pub const fn from_ne(n: u32) -> Self

Creates a new big-endian integer from a native-endian integer.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au32;

if cfg!(target_endian = "big") {
    assert_eq!(Be::<u32>::from_ne(n).0, n);
} else {
    assert_eq!(Be::<u32>::from_ne(n).0, n.swap_bytes());
}

Source

pub const fn from_le(n: Le<u32>) -> Self

Creates a new big-endian integer from a little-endian integer.

This always swaps the bytes.

§Examples

use endian_num::{Be, Le};

let n = 0x1Au32;

assert_eq!(Be::<u32>::from_le(Le(n)).0, n.swap_bytes());

Source

pub const fn to_ne(self) -> u32

Returns the integer in native-endian byte order.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au32;

if cfg!(target_endian = "big") {
    assert_eq!(Be(n).to_ne(), n);
} else {
    assert_eq!(Be(n).to_ne(), n.swap_bytes());
}

Source

pub const fn to_le(self) -> Le<u32>

Returns the integer in little-endian byte order.

This always swaps the bytes.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au32;

assert_eq!(Be(n).to_le().0, n.swap_bytes());

Source

pub const fn to_be_bytes(self) -> [u8; 4]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

§Examples

use endian_num::Be;

let bytes = Be::<u32>::from_ne(0x12345678).to_be_bytes();
assert_eq!(bytes, [0x12, 0x34, 0x56, 0x78]);

Source

pub const fn to_le_bytes(self) -> [u8; 4]

Return the memory representation of this integer as a byte array in little-endian byte order.

§Examples

use endian_num::Be;

let bytes = Be::<u32>::from_ne(0x12345678).to_le_bytes();
assert_eq!(bytes, [0x78, 0x56, 0x34, 0x12]);

Source

pub const fn to_ne_bytes(self) -> [u8; 4]

Return the memory representation of this integer as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

§Examples

use endian_num::Be;

let bytes = Be::<u32>::from_ne(0x12345678).to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12, 0x34, 0x56, 0x78]
    } else {
        [0x78, 0x56, 0x34, 0x12]
    }
);

Source

pub const fn from_be_bytes(bytes: [u8; 4]) -> Self

Create a big endian integer value from its representation as a byte array in big endian.

§Examples

use endian_num::Be;

let value = Be::<u32>::from_be_bytes([0x12, 0x34, 0x56, 0x78]);
assert_eq!(value.to_ne(), 0x12345678);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_be_u32(input: &mut &[u8]) -> Be<u32> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u32>>());
    *input = rest;
    Be::<u32>::from_be_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_le_bytes(bytes: [u8; 4]) -> Self

Create a big endian integer value from its representation as a byte array in little endian.

§Examples

use endian_num::Be;

let value = Be::<u32>::from_le_bytes([0x78, 0x56, 0x34, 0x12]);
assert_eq!(value.to_ne(), 0x12345678);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_le_u32(input: &mut &[u8]) -> Be<u32> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u32>>());
    *input = rest;
    Be::<u32>::from_le_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_ne_bytes(bytes: [u8; 4]) -> Self

Create a big endian integer value from its memory representation as a byte array in native endianness.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

§Examples

use endian_num::Be;

let value = Be::<u32>::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12, 0x34, 0x56, 0x78]
} else {
    [0x78, 0x56, 0x34, 0x12]
});
assert_eq!(value.to_ne(), 0x12345678);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_ne_u32(input: &mut &[u8]) -> Be<u32> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u32>>());
    *input = rest;
    Be::<u32>::from_ne_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u32>::from_ne(0x10000b3);
let m = Be::<u32>::from_ne(0xb301);

assert_eq!(n.rotate_left(8), m);

Source

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u32>::from_ne(0xb301);
let m = Be::<u32>::from_ne(0x10000b3);

assert_eq!(n.rotate_right(8), m);

Source

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x12345678u32);
let m = n.swap_bytes();

assert_eq!(m, Be(0x78563412));

Source

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer.

The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x12345678u32);
let m = n.reverse_bits();

assert_eq!(m, Be(0x1e6a2c48));
assert_eq!(Be(0), Be(0u32).reverse_bits());

Source

pub const fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<u32>::from_ne(2).pow(5).to_ne(), 32);

Basic usage:

use endian_num::Be;

assert_eq!(Be::<u64>::BITS, u64::BITS);

Source

pub const fn from_ne(n: u64) -> Self

Creates a new big-endian integer from a native-endian integer.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au64;

if cfg!(target_endian = "big") {
    assert_eq!(Be::<u64>::from_ne(n).0, n);
} else {
    assert_eq!(Be::<u64>::from_ne(n).0, n.swap_bytes());
}

Source

pub const fn from_le(n: Le<u64>) -> Self

Creates a new big-endian integer from a little-endian integer.

This always swaps the bytes.

§Examples

use endian_num::{Be, Le};

let n = 0x1Au64;

assert_eq!(Be::<u64>::from_le(Le(n)).0, n.swap_bytes());

Source

pub const fn to_ne(self) -> u64

Returns the integer in native-endian byte order.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au64;

if cfg!(target_endian = "big") {
    assert_eq!(Be(n).to_ne(), n);
} else {
    assert_eq!(Be(n).to_ne(), n.swap_bytes());
}

Source

pub const fn to_le(self) -> Le<u64>

Returns the integer in little-endian byte order.

This always swaps the bytes.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au64;

assert_eq!(Be(n).to_le().0, n.swap_bytes());

Source

pub const fn to_be_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

§Examples

use endian_num::Be;

let bytes = Be::<u64>::from_ne(0x1234567890123456).to_be_bytes();
assert_eq!(bytes, [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]);

Source

pub const fn to_le_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in little-endian byte order.

§Examples

use endian_num::Be;

let bytes = Be::<u64>::from_ne(0x1234567890123456).to_le_bytes();
assert_eq!(bytes, [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);

Source

pub const fn to_ne_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

§Examples

use endian_num::Be;

let bytes = Be::<u64>::from_ne(0x1234567890123456).to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]
    } else {
        [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
    }
);

Source

pub const fn from_be_bytes(bytes: [u8; 8]) -> Self

Create a big endian integer value from its representation as a byte array in big endian.

§Examples

use endian_num::Be;

let value = Be::<u64>::from_be_bytes([0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]);
assert_eq!(value.to_ne(), 0x1234567890123456);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_be_u64(input: &mut &[u8]) -> Be<u64> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u64>>());
    *input = rest;
    Be::<u64>::from_be_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_le_bytes(bytes: [u8; 8]) -> Self

Create a big endian integer value from its representation as a byte array in little endian.

§Examples

use endian_num::Be;

let value = Be::<u64>::from_le_bytes([0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);
assert_eq!(value.to_ne(), 0x1234567890123456);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_le_u64(input: &mut &[u8]) -> Be<u64> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u64>>());
    *input = rest;
    Be::<u64>::from_le_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_ne_bytes(bytes: [u8; 8]) -> Self

Create a big endian integer value from its memory representation as a byte array in native endianness.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

§Examples

use endian_num::Be;

let value = Be::<u64>::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]
} else {
    [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
});
assert_eq!(value.to_ne(), 0x1234567890123456);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_ne_u64(input: &mut &[u8]) -> Be<u64> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u64>>());
    *input = rest;
    Be::<u64>::from_ne_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u64>::from_ne(0xaa00000000006e1);
let m = Be::<u64>::from_ne(0x6e10aa);

assert_eq!(n.rotate_left(12), m);

Source

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u64>::from_ne(0x6e10aa);
let m = Be::<u64>::from_ne(0xaa00000000006e1);

assert_eq!(n.rotate_right(12), m);

Source

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x1234567890123456u64);
let m = n.swap_bytes();

assert_eq!(m, Be(0x5634129078563412));

Source

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer.

The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x1234567890123456u64);
let m = n.reverse_bits();

assert_eq!(m, Be(0x6a2c48091e6a2c48));
assert_eq!(Be(0), Be(0u64).reverse_bits());

Source

pub const fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<u64>::from_ne(2).pow(5).to_ne(), 32);

Basic usage:

use endian_num::Be;

assert_eq!(Be::<u128>::BITS, u128::BITS);

Source

pub const fn from_ne(n: u128) -> Self

Creates a new big-endian integer from a native-endian integer.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au128;

if cfg!(target_endian = "big") {
    assert_eq!(Be::<u128>::from_ne(n).0, n);
} else {
    assert_eq!(Be::<u128>::from_ne(n).0, n.swap_bytes());
}

Source

pub const fn from_le(n: Le<u128>) -> Self

Creates a new big-endian integer from a little-endian integer.

This always swaps the bytes.

§Examples

use endian_num::{Be, Le};

let n = 0x1Au128;

assert_eq!(Be::<u128>::from_le(Le(n)).0, n.swap_bytes());

Source

pub const fn to_ne(self) -> u128

Returns the integer in native-endian byte order.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au128;

if cfg!(target_endian = "big") {
    assert_eq!(Be(n).to_ne(), n);
} else {
    assert_eq!(Be(n).to_ne(), n.swap_bytes());
}

Source

pub const fn to_le(self) -> Le<u128>

Returns the integer in little-endian byte order.

This always swaps the bytes.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Au128;

assert_eq!(Be(n).to_le().0, n.swap_bytes());

Source

pub const fn to_be_bytes(self) -> [u8; 16]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

§Examples

use endian_num::Be;

let bytes = Be::<u128>::from_ne(0x12345678901234567890123456789012).to_be_bytes();
assert_eq!(bytes, [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]);

Source

pub const fn to_le_bytes(self) -> [u8; 16]

Return the memory representation of this integer as a byte array in little-endian byte order.

§Examples

use endian_num::Be;

let bytes = Be::<u128>::from_ne(0x12345678901234567890123456789012).to_le_bytes();
assert_eq!(bytes, [0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);

Source

pub const fn to_ne_bytes(self) -> [u8; 16]

Return the memory representation of this integer as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

§Examples

use endian_num::Be;

let bytes = Be::<u128>::from_ne(0x12345678901234567890123456789012).to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]
    } else {
        [0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
    }
);

Source

pub const fn from_be_bytes(bytes: [u8; 16]) -> Self

Create a big endian integer value from its representation as a byte array in big endian.

§Examples

use endian_num::Be;

let value = Be::<u128>::from_be_bytes([0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]);
assert_eq!(value.to_ne(), 0x12345678901234567890123456789012);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_be_u128(input: &mut &[u8]) -> Be<u128> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u128>>());
    *input = rest;
    Be::<u128>::from_be_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_le_bytes(bytes: [u8; 16]) -> Self

Create a big endian integer value from its representation as a byte array in little endian.

§Examples

use endian_num::Be;

let value = Be::<u128>::from_le_bytes([0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);
assert_eq!(value.to_ne(), 0x12345678901234567890123456789012);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_le_u128(input: &mut &[u8]) -> Be<u128> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u128>>());
    *input = rest;
    Be::<u128>::from_le_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_ne_bytes(bytes: [u8; 16]) -> Self

Create a big endian integer value from its memory representation as a byte array in native endianness.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

§Examples

use endian_num::Be;

let value = Be::<u128>::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]
} else {
    [0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
});
assert_eq!(value.to_ne(), 0x12345678901234567890123456789012);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_ne_u128(input: &mut &[u8]) -> Be<u128> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<u128>>());
    *input = rest;
    Be::<u128>::from_ne_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u128>::from_ne(0x13f40000000000000000000000004f76);
let m = Be::<u128>::from_ne(0x4f7613f4);

assert_eq!(n.rotate_left(16), m);

Source

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u128>::from_ne(0x4f7613f4);
let m = Be::<u128>::from_ne(0x13f40000000000000000000000004f76);

assert_eq!(n.rotate_right(16), m);

Source

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x12345678901234567890123456789012u128);
let m = n.swap_bytes();

assert_eq!(m, Be(0x12907856341290785634129078563412));

Source

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer.

The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x12345678901234567890123456789012u128);
let m = n.reverse_bits();

assert_eq!(m, Be(0x48091e6a2c48091e6a2c48091e6a2c48));
assert_eq!(Be(0), Be(0u128).reverse_bits());

Source

pub const fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<u128>::from_ne(2).pow(5).to_ne(), 32);

Basic usage:

use endian_num::Be;

assert_eq!(Be::<usize>::BITS, usize::BITS);

Source

pub const fn from_ne(n: usize) -> Self

Creates a new big-endian integer from a native-endian integer.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ausize;

if cfg!(target_endian = "big") {
    assert_eq!(Be::<usize>::from_ne(n).0, n);
} else {
    assert_eq!(Be::<usize>::from_ne(n).0, n.swap_bytes());
}

Source

pub const fn from_le(n: Le<usize>) -> Self

Creates a new big-endian integer from a little-endian integer.

This always swaps the bytes.

§Examples

use endian_num::{Be, Le};

let n = 0x1Ausize;

assert_eq!(Be::<usize>::from_le(Le(n)).0, n.swap_bytes());

Source

pub const fn to_ne(self) -> usize

Returns the integer in native-endian byte order.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ausize;

if cfg!(target_endian = "big") {
    assert_eq!(Be(n).to_ne(), n);
} else {
    assert_eq!(Be(n).to_ne(), n.swap_bytes());
}

Source

pub const fn to_le(self) -> Le<usize>

Returns the integer in little-endian byte order.

This always swaps the bytes.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ausize;

assert_eq!(Be(n).to_le().0, n.swap_bytes());

Source

pub const fn to_be_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

§Examples

use endian_num::Be;

let bytes = Be::<usize>::from_ne(0x1234567890123456).to_be_bytes();
assert_eq!(bytes, [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]);

Source

pub const fn to_le_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in little-endian byte order.

§Examples

use endian_num::Be;

let bytes = Be::<usize>::from_ne(0x1234567890123456).to_le_bytes();
assert_eq!(bytes, [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);

Source

pub const fn to_ne_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

§Examples

use endian_num::Be;

let bytes = Be::<usize>::from_ne(0x1234567890123456).to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]
    } else {
        [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
    }
);

Source

pub const fn from_be_bytes(bytes: [u8; 8]) -> Self

Create a big endian integer value from its representation as a byte array in big endian.

§Examples

use endian_num::Be;

let value = Be::<usize>::from_be_bytes([0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]);
assert_eq!(value.to_ne(), 0x1234567890123456);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_be_usize(input: &mut &[u8]) -> Be<usize> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<usize>>());
    *input = rest;
    Be::<usize>::from_be_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_le_bytes(bytes: [u8; 8]) -> Self

Create a big endian integer value from its representation as a byte array in little endian.

§Examples

use endian_num::Be;

let value = Be::<usize>::from_le_bytes([0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);
assert_eq!(value.to_ne(), 0x1234567890123456);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_le_usize(input: &mut &[u8]) -> Be<usize> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<usize>>());
    *input = rest;
    Be::<usize>::from_le_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_ne_bytes(bytes: [u8; 8]) -> Self

Create a big endian integer value from its memory representation as a byte array in native endianness.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

§Examples

use endian_num::Be;

let value = Be::<usize>::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]
} else {
    [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
});
assert_eq!(value.to_ne(), 0x1234567890123456);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_ne_usize(input: &mut &[u8]) -> Be<usize> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<usize>>());
    *input = rest;
    Be::<usize>::from_ne_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<usize>::from_ne(0xaa00000000006e1);
let m = Be::<usize>::from_ne(0x6e10aa);

assert_eq!(n.rotate_left(12), m);

Source

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<usize>::from_ne(0x6e10aa);
let m = Be::<usize>::from_ne(0xaa00000000006e1);

assert_eq!(n.rotate_right(12), m);

Source

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x1234567890123456usize);
let m = n.swap_bytes();

assert_eq!(m, Be(0x5634129078563412));

Source

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer.

The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x1234567890123456usize);
let m = n.reverse_bits();

assert_eq!(m, Be(0x6a2c48091e6a2c48));
assert_eq!(Be(0), Be(0usize).reverse_bits());

Source

pub const fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<usize>::from_ne(2).pow(5).to_ne(), 32);

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i8>::BITS, i8::BITS);

Source

pub const fn from_ne(n: i8) -> Self

Creates a new big-endian integer from a native-endian integer.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai8;

if cfg!(target_endian = "big") {
    assert_eq!(Be::<i8>::from_ne(n).0, n);
} else {
    assert_eq!(Be::<i8>::from_ne(n).0, n.swap_bytes());
}

Source

pub const fn from_le(n: Le<i8>) -> Self

Creates a new big-endian integer from a little-endian integer.

This always swaps the bytes.

§Examples

use endian_num::{Be, Le};

let n = 0x1Ai8;

assert_eq!(Be::<i8>::from_le(Le(n)).0, n.swap_bytes());

Source

pub const fn to_ne(self) -> i8

Returns the integer in native-endian byte order.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai8;

if cfg!(target_endian = "big") {
    assert_eq!(Be(n).to_ne(), n);
} else {
    assert_eq!(Be(n).to_ne(), n.swap_bytes());
}

Source

pub const fn to_le(self) -> Le<i8>

Returns the integer in little-endian byte order.

This always swaps the bytes.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai8;

assert_eq!(Be(n).to_le().0, n.swap_bytes());

Source

pub const fn to_be_bytes(self) -> [u8; 1]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

§Examples

use endian_num::Be;

let bytes = Be::<i8>::from_ne(0x12).to_be_bytes();
assert_eq!(bytes, [0x12]);

Source

pub const fn to_le_bytes(self) -> [u8; 1]

Return the memory representation of this integer as a byte array in little-endian byte order.

§Examples

use endian_num::Be;

let bytes = Be::<i8>::from_ne(0x12).to_le_bytes();
assert_eq!(bytes, [0x12]);

Source

pub const fn to_ne_bytes(self) -> [u8; 1]

Return the memory representation of this integer as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

§Examples

use endian_num::Be;

let bytes = Be::<i8>::from_ne(0x12).to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12]
    } else {
        [0x12]
    }
);

Source

pub const fn from_be_bytes(bytes: [u8; 1]) -> Self

Create a big endian integer value from its representation as a byte array in big endian.

§Examples

use endian_num::Be;

let value = Be::<i8>::from_be_bytes([0x12]);
assert_eq!(value.to_ne(), 0x12);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_be_i8(input: &mut &[u8]) -> Be<i8> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i8>>());
    *input = rest;
    Be::<i8>::from_be_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_le_bytes(bytes: [u8; 1]) -> Self

Create a big endian integer value from its representation as a byte array in little endian.

§Examples

use endian_num::Be;

let value = Be::<i8>::from_le_bytes([0x12]);
assert_eq!(value.to_ne(), 0x12);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_le_i8(input: &mut &[u8]) -> Be<i8> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i8>>());
    *input = rest;
    Be::<i8>::from_le_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_ne_bytes(bytes: [u8; 1]) -> Self

Create a big endian integer value from its memory representation as a byte array in native endianness.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

§Examples

use endian_num::Be;

let value = Be::<i8>::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12]
} else {
    [0x12]
});
assert_eq!(value.to_ne(), 0x12);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_ne_i8(input: &mut &[u8]) -> Be<i8> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i8>>());
    *input = rest;
    Be::<i8>::from_ne_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i8>::from_ne(-0x7e);
let m = Be::<i8>::from_ne(0xa);

assert_eq!(n.rotate_left(2), m);

Source

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i8>::from_ne(0xa);
let m = Be::<i8>::from_ne(-0x7e);

assert_eq!(n.rotate_right(2), m);

Source

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x12i8);
let m = n.swap_bytes();

assert_eq!(m, Be(0x12));

Source

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer.

The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x12i8);
let m = n.reverse_bits();

assert_eq!(m, Be(0x48));
assert_eq!(Be(0), Be(0i8).reverse_bits());

Source

pub const fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i8>::from_ne(2).pow(5).to_ne(), 32);

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i16>::BITS, i16::BITS);

Source

pub const fn from_ne(n: i16) -> Self

Creates a new big-endian integer from a native-endian integer.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai16;

if cfg!(target_endian = "big") {
    assert_eq!(Be::<i16>::from_ne(n).0, n);
} else {
    assert_eq!(Be::<i16>::from_ne(n).0, n.swap_bytes());
}

Source

pub const fn from_le(n: Le<i16>) -> Self

Creates a new big-endian integer from a little-endian integer.

This always swaps the bytes.

§Examples

use endian_num::{Be, Le};

let n = 0x1Ai16;

assert_eq!(Be::<i16>::from_le(Le(n)).0, n.swap_bytes());

Source

pub const fn to_ne(self) -> i16

Returns the integer in native-endian byte order.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai16;

if cfg!(target_endian = "big") {
    assert_eq!(Be(n).to_ne(), n);
} else {
    assert_eq!(Be(n).to_ne(), n.swap_bytes());
}

Source

pub const fn to_le(self) -> Le<i16>

Returns the integer in little-endian byte order.

This always swaps the bytes.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai16;

assert_eq!(Be(n).to_le().0, n.swap_bytes());

Source

pub const fn to_be_bytes(self) -> [u8; 2]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

§Examples

use endian_num::Be;

let bytes = Be::<i16>::from_ne(0x1234).to_be_bytes();
assert_eq!(bytes, [0x12, 0x34]);

Source

pub const fn to_le_bytes(self) -> [u8; 2]

Return the memory representation of this integer as a byte array in little-endian byte order.

§Examples

use endian_num::Be;

let bytes = Be::<i16>::from_ne(0x1234).to_le_bytes();
assert_eq!(bytes, [0x34, 0x12]);

Source

pub const fn to_ne_bytes(self) -> [u8; 2]

Return the memory representation of this integer as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

§Examples

use endian_num::Be;

let bytes = Be::<i16>::from_ne(0x1234).to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12, 0x34]
    } else {
        [0x34, 0x12]
    }
);

Source

pub const fn from_be_bytes(bytes: [u8; 2]) -> Self

Create a big endian integer value from its representation as a byte array in big endian.

§Examples

use endian_num::Be;

let value = Be::<i16>::from_be_bytes([0x12, 0x34]);
assert_eq!(value.to_ne(), 0x1234);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_be_i16(input: &mut &[u8]) -> Be<i16> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i16>>());
    *input = rest;
    Be::<i16>::from_be_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_le_bytes(bytes: [u8; 2]) -> Self

Create a big endian integer value from its representation as a byte array in little endian.

§Examples

use endian_num::Be;

let value = Be::<i16>::from_le_bytes([0x34, 0x12]);
assert_eq!(value.to_ne(), 0x1234);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_le_i16(input: &mut &[u8]) -> Be<i16> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i16>>());
    *input = rest;
    Be::<i16>::from_le_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_ne_bytes(bytes: [u8; 2]) -> Self

Create a big endian integer value from its memory representation as a byte array in native endianness.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

§Examples

use endian_num::Be;

let value = Be::<i16>::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12, 0x34]
} else {
    [0x34, 0x12]
});
assert_eq!(value.to_ne(), 0x1234);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_ne_i16(input: &mut &[u8]) -> Be<i16> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i16>>());
    *input = rest;
    Be::<i16>::from_ne_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i16>::from_ne(-0x5ffd);
let m = Be::<i16>::from_ne(0x3a);

assert_eq!(n.rotate_left(4), m);

Source

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i16>::from_ne(0x3a);
let m = Be::<i16>::from_ne(-0x5ffd);

assert_eq!(n.rotate_right(4), m);

Source

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x1234i16);
let m = n.swap_bytes();

assert_eq!(m, Be(0x3412));

Source

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer.

The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x1234i16);
let m = n.reverse_bits();

assert_eq!(m, Be(0x2c48));
assert_eq!(Be(0), Be(0i16).reverse_bits());

Source

pub const fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i16>::from_ne(2).pow(5).to_ne(), 32);

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i32>::BITS, i32::BITS);

Source

pub const fn from_ne(n: i32) -> Self

Creates a new big-endian integer from a native-endian integer.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai32;

if cfg!(target_endian = "big") {
    assert_eq!(Be::<i32>::from_ne(n).0, n);
} else {
    assert_eq!(Be::<i32>::from_ne(n).0, n.swap_bytes());
}

Source

pub const fn from_le(n: Le<i32>) -> Self

Creates a new big-endian integer from a little-endian integer.

This always swaps the bytes.

§Examples

use endian_num::{Be, Le};

let n = 0x1Ai32;

assert_eq!(Be::<i32>::from_le(Le(n)).0, n.swap_bytes());

Source

pub const fn to_ne(self) -> i32

Returns the integer in native-endian byte order.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai32;

if cfg!(target_endian = "big") {
    assert_eq!(Be(n).to_ne(), n);
} else {
    assert_eq!(Be(n).to_ne(), n.swap_bytes());
}

Source

pub const fn to_le(self) -> Le<i32>

Returns the integer in little-endian byte order.

This always swaps the bytes.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai32;

assert_eq!(Be(n).to_le().0, n.swap_bytes());

Source

pub const fn to_be_bytes(self) -> [u8; 4]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

§Examples

use endian_num::Be;

let bytes = Be::<i32>::from_ne(0x12345678).to_be_bytes();
assert_eq!(bytes, [0x12, 0x34, 0x56, 0x78]);

Source

pub const fn to_le_bytes(self) -> [u8; 4]

Return the memory representation of this integer as a byte array in little-endian byte order.

§Examples

use endian_num::Be;

let bytes = Be::<i32>::from_ne(0x12345678).to_le_bytes();
assert_eq!(bytes, [0x78, 0x56, 0x34, 0x12]);

Source

pub const fn to_ne_bytes(self) -> [u8; 4]

Return the memory representation of this integer as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

§Examples

use endian_num::Be;

let bytes = Be::<i32>::from_ne(0x12345678).to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12, 0x34, 0x56, 0x78]
    } else {
        [0x78, 0x56, 0x34, 0x12]
    }
);

Source

pub const fn from_be_bytes(bytes: [u8; 4]) -> Self

Create a big endian integer value from its representation as a byte array in big endian.

§Examples

use endian_num::Be;

let value = Be::<i32>::from_be_bytes([0x12, 0x34, 0x56, 0x78]);
assert_eq!(value.to_ne(), 0x12345678);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_be_i32(input: &mut &[u8]) -> Be<i32> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i32>>());
    *input = rest;
    Be::<i32>::from_be_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_le_bytes(bytes: [u8; 4]) -> Self

Create a big endian integer value from its representation as a byte array in little endian.

§Examples

use endian_num::Be;

let value = Be::<i32>::from_le_bytes([0x78, 0x56, 0x34, 0x12]);
assert_eq!(value.to_ne(), 0x12345678);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_le_i32(input: &mut &[u8]) -> Be<i32> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i32>>());
    *input = rest;
    Be::<i32>::from_le_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_ne_bytes(bytes: [u8; 4]) -> Self

Create a big endian integer value from its memory representation as a byte array in native endianness.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

§Examples

use endian_num::Be;

let value = Be::<i32>::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12, 0x34, 0x56, 0x78]
} else {
    [0x78, 0x56, 0x34, 0x12]
});
assert_eq!(value.to_ne(), 0x12345678);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_ne_i32(input: &mut &[u8]) -> Be<i32> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i32>>());
    *input = rest;
    Be::<i32>::from_ne_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i32>::from_ne(0x10000b3);
let m = Be::<i32>::from_ne(0xb301);

assert_eq!(n.rotate_left(8), m);

Source

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i32>::from_ne(0xb301);
let m = Be::<i32>::from_ne(0x10000b3);

assert_eq!(n.rotate_right(8), m);

Source

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x12345678i32);
let m = n.swap_bytes();

assert_eq!(m, Be(0x78563412));

Source

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer.

The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x12345678i32);
let m = n.reverse_bits();

assert_eq!(m, Be(0x1e6a2c48));
assert_eq!(Be(0), Be(0i32).reverse_bits());

Source

pub const fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i32>::from_ne(2).pow(5).to_ne(), 32);

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i64>::BITS, i64::BITS);

Source

pub const fn from_ne(n: i64) -> Self

Creates a new big-endian integer from a native-endian integer.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai64;

if cfg!(target_endian = "big") {
    assert_eq!(Be::<i64>::from_ne(n).0, n);
} else {
    assert_eq!(Be::<i64>::from_ne(n).0, n.swap_bytes());
}

Source

pub const fn from_le(n: Le<i64>) -> Self

Creates a new big-endian integer from a little-endian integer.

This always swaps the bytes.

§Examples

use endian_num::{Be, Le};

let n = 0x1Ai64;

assert_eq!(Be::<i64>::from_le(Le(n)).0, n.swap_bytes());

Source

pub const fn to_ne(self) -> i64

Returns the integer in native-endian byte order.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai64;

if cfg!(target_endian = "big") {
    assert_eq!(Be(n).to_ne(), n);
} else {
    assert_eq!(Be(n).to_ne(), n.swap_bytes());
}

Source

pub const fn to_le(self) -> Le<i64>

Returns the integer in little-endian byte order.

This always swaps the bytes.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai64;

assert_eq!(Be(n).to_le().0, n.swap_bytes());

Source

pub const fn to_be_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

§Examples

use endian_num::Be;

let bytes = Be::<i64>::from_ne(0x1234567890123456).to_be_bytes();
assert_eq!(bytes, [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]);

Source

pub const fn to_le_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in little-endian byte order.

§Examples

use endian_num::Be;

let bytes = Be::<i64>::from_ne(0x1234567890123456).to_le_bytes();
assert_eq!(bytes, [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);

Source

pub const fn to_ne_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

§Examples

use endian_num::Be;

let bytes = Be::<i64>::from_ne(0x1234567890123456).to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]
    } else {
        [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
    }
);

Source

pub const fn from_be_bytes(bytes: [u8; 8]) -> Self

Create a big endian integer value from its representation as a byte array in big endian.

§Examples

use endian_num::Be;

let value = Be::<i64>::from_be_bytes([0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]);
assert_eq!(value.to_ne(), 0x1234567890123456);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_be_i64(input: &mut &[u8]) -> Be<i64> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i64>>());
    *input = rest;
    Be::<i64>::from_be_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_le_bytes(bytes: [u8; 8]) -> Self

Create a big endian integer value from its representation as a byte array in little endian.

§Examples

use endian_num::Be;

let value = Be::<i64>::from_le_bytes([0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);
assert_eq!(value.to_ne(), 0x1234567890123456);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_le_i64(input: &mut &[u8]) -> Be<i64> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i64>>());
    *input = rest;
    Be::<i64>::from_le_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_ne_bytes(bytes: [u8; 8]) -> Self

Create a big endian integer value from its memory representation as a byte array in native endianness.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

§Examples

use endian_num::Be;

let value = Be::<i64>::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]
} else {
    [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
});
assert_eq!(value.to_ne(), 0x1234567890123456);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_ne_i64(input: &mut &[u8]) -> Be<i64> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i64>>());
    *input = rest;
    Be::<i64>::from_ne_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i64>::from_ne(0xaa00000000006e1);
let m = Be::<i64>::from_ne(0x6e10aa);

assert_eq!(n.rotate_left(12), m);

Source

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i64>::from_ne(0x6e10aa);
let m = Be::<i64>::from_ne(0xaa00000000006e1);

assert_eq!(n.rotate_right(12), m);

Source

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x1234567890123456i64);
let m = n.swap_bytes();

assert_eq!(m, Be(0x5634129078563412));

Source

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer.

The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x1234567890123456i64);
let m = n.reverse_bits();

assert_eq!(m, Be(0x6a2c48091e6a2c48));
assert_eq!(Be(0), Be(0i64).reverse_bits());

Source

pub const fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i64>::from_ne(2).pow(5).to_ne(), 32);

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i128>::BITS, i128::BITS);

Source

pub const fn from_ne(n: i128) -> Self

Creates a new big-endian integer from a native-endian integer.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai128;

if cfg!(target_endian = "big") {
    assert_eq!(Be::<i128>::from_ne(n).0, n);
} else {
    assert_eq!(Be::<i128>::from_ne(n).0, n.swap_bytes());
}

Source

pub const fn from_le(n: Le<i128>) -> Self

Creates a new big-endian integer from a little-endian integer.

This always swaps the bytes.

§Examples

use endian_num::{Be, Le};

let n = 0x1Ai128;

assert_eq!(Be::<i128>::from_le(Le(n)).0, n.swap_bytes());

Source

pub const fn to_ne(self) -> i128

Returns the integer in native-endian byte order.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai128;

if cfg!(target_endian = "big") {
    assert_eq!(Be(n).to_ne(), n);
} else {
    assert_eq!(Be(n).to_ne(), n.swap_bytes());
}

Source

pub const fn to_le(self) -> Le<i128>

Returns the integer in little-endian byte order.

This always swaps the bytes.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Ai128;

assert_eq!(Be(n).to_le().0, n.swap_bytes());

Source

pub const fn to_be_bytes(self) -> [u8; 16]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

§Examples

use endian_num::Be;

let bytes = Be::<i128>::from_ne(0x12345678901234567890123456789012).to_be_bytes();
assert_eq!(bytes, [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]);

Source

pub const fn to_le_bytes(self) -> [u8; 16]

Return the memory representation of this integer as a byte array in little-endian byte order.

§Examples

use endian_num::Be;

let bytes = Be::<i128>::from_ne(0x12345678901234567890123456789012).to_le_bytes();
assert_eq!(bytes, [0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);

Source

pub const fn to_ne_bytes(self) -> [u8; 16]

Return the memory representation of this integer as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

§Examples

use endian_num::Be;

let bytes = Be::<i128>::from_ne(0x12345678901234567890123456789012).to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]
    } else {
        [0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
    }
);

Source

pub const fn from_be_bytes(bytes: [u8; 16]) -> Self

Create a big endian integer value from its representation as a byte array in big endian.

§Examples

use endian_num::Be;

let value = Be::<i128>::from_be_bytes([0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]);
assert_eq!(value.to_ne(), 0x12345678901234567890123456789012);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_be_i128(input: &mut &[u8]) -> Be<i128> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i128>>());
    *input = rest;
    Be::<i128>::from_be_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_le_bytes(bytes: [u8; 16]) -> Self

Create a big endian integer value from its representation as a byte array in little endian.

§Examples

use endian_num::Be;

let value = Be::<i128>::from_le_bytes([0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);
assert_eq!(value.to_ne(), 0x12345678901234567890123456789012);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_le_i128(input: &mut &[u8]) -> Be<i128> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i128>>());
    *input = rest;
    Be::<i128>::from_le_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_ne_bytes(bytes: [u8; 16]) -> Self

Create a big endian integer value from its memory representation as a byte array in native endianness.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

§Examples

use endian_num::Be;

let value = Be::<i128>::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]
} else {
    [0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
});
assert_eq!(value.to_ne(), 0x12345678901234567890123456789012);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_ne_i128(input: &mut &[u8]) -> Be<i128> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<i128>>());
    *input = rest;
    Be::<i128>::from_ne_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i128>::from_ne(0x13f40000000000000000000000004f76);
let m = Be::<i128>::from_ne(0x4f7613f4);

assert_eq!(n.rotate_left(16), m);

Source

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i128>::from_ne(0x4f7613f4);
let m = Be::<i128>::from_ne(0x13f40000000000000000000000004f76);

assert_eq!(n.rotate_right(16), m);

Source

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x12345678901234567890123456789012i128);
let m = n.swap_bytes();

assert_eq!(m, Be(0x12907856341290785634129078563412));

Source

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer.

The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x12345678901234567890123456789012i128);
let m = n.reverse_bits();

assert_eq!(m, Be(0x48091e6a2c48091e6a2c48091e6a2c48));
assert_eq!(Be(0), Be(0i128).reverse_bits());

Source

pub const fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i128>::from_ne(2).pow(5).to_ne(), 32);

Basic usage:

use endian_num::Be;

assert_eq!(Be::<isize>::BITS, isize::BITS);

Source

pub const fn from_ne(n: isize) -> Self

Creates a new big-endian integer from a native-endian integer.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Aisize;

if cfg!(target_endian = "big") {
    assert_eq!(Be::<isize>::from_ne(n).0, n);
} else {
    assert_eq!(Be::<isize>::from_ne(n).0, n.swap_bytes());
}

Source

pub const fn from_le(n: Le<isize>) -> Self

Creates a new big-endian integer from a little-endian integer.

This always swaps the bytes.

§Examples

use endian_num::{Be, Le};

let n = 0x1Aisize;

assert_eq!(Be::<isize>::from_le(Le(n)).0, n.swap_bytes());

Source

pub const fn to_ne(self) -> isize

Returns the integer in native-endian byte order.

On big endian, this is a no-op. On little endian, the bytes are swapped.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Aisize;

if cfg!(target_endian = "big") {
    assert_eq!(Be(n).to_ne(), n);
} else {
    assert_eq!(Be(n).to_ne(), n.swap_bytes());
}

Source

pub const fn to_le(self) -> Le<isize>

Returns the integer in little-endian byte order.

This always swaps the bytes.

§Examples

Basic usage:

use endian_num::Be;

let n = 0x1Aisize;

assert_eq!(Be(n).to_le().0, n.swap_bytes());

Source

pub const fn to_be_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

§Examples

use endian_num::Be;

let bytes = Be::<isize>::from_ne(0x1234567890123456).to_be_bytes();
assert_eq!(bytes, [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]);

Source

pub const fn to_le_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in little-endian byte order.

§Examples

use endian_num::Be;

let bytes = Be::<isize>::from_ne(0x1234567890123456).to_le_bytes();
assert_eq!(bytes, [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);

Source

pub const fn to_ne_bytes(self) -> [u8; 8]

Return the memory representation of this integer as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

§Examples

use endian_num::Be;

let bytes = Be::<isize>::from_ne(0x1234567890123456).to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]
    } else {
        [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
    }
);

Source

pub const fn from_be_bytes(bytes: [u8; 8]) -> Self

Create a big endian integer value from its representation as a byte array in big endian.

§Examples

use endian_num::Be;

let value = Be::<isize>::from_be_bytes([0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]);
assert_eq!(value.to_ne(), 0x1234567890123456);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_be_isize(input: &mut &[u8]) -> Be<isize> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<isize>>());
    *input = rest;
    Be::<isize>::from_be_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_le_bytes(bytes: [u8; 8]) -> Self

Create a big endian integer value from its representation as a byte array in little endian.

§Examples

use endian_num::Be;

let value = Be::<isize>::from_le_bytes([0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);
assert_eq!(value.to_ne(), 0x1234567890123456);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_le_isize(input: &mut &[u8]) -> Be<isize> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<isize>>());
    *input = rest;
    Be::<isize>::from_le_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn from_ne_bytes(bytes: [u8; 8]) -> Self

Create a big endian integer value from its memory representation as a byte array in native endianness.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

§Examples

use endian_num::Be;

let value = Be::<isize>::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]
} else {
    [0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
});
assert_eq!(value.to_ne(), 0x1234567890123456);

When starting from a slice rather than an array, fallible conversion APIs can be used:

use endian_num::Be;

fn read_ne_isize(input: &mut &[u8]) -> Be<isize> {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<Be<isize>>());
    *input = rest;
    Be::<isize>::from_ne_bytes(int_bytes.try_into().unwrap())
}

Source

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<isize>::from_ne(0xaa00000000006e1);
let m = Be::<isize>::from_ne(0x6e10aa);

assert_eq!(n.rotate_left(12), m);

Source

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<isize>::from_ne(0x6e10aa);
let m = Be::<isize>::from_ne(0xaa00000000006e1);

assert_eq!(n.rotate_right(12), m);

Source

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x1234567890123456isize);
let m = n.swap_bytes();

assert_eq!(m, Be(0x5634129078563412));

Source

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer.

The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0x1234567890123456isize);
let m = n.reverse_bits();

assert_eq!(m, Be(0x6a2c48091e6a2c48));
assert_eq!(Be(0), Be(0isize).reverse_bits());

Source

pub const fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<isize>::from_ne(2).pow(5).to_ne(), 32);

Source §

impl Be<i8>

Source

pub const fn abs(self) -> Self

Computes the absolute value of self.

See i8::abs for documentation on overflow behavior.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i8>::from_ne(10).abs(), Be::<i8>::from_ne(10));
assert_eq!(Be::<i8>::from_ne(-10).abs(), Be::<i8>::from_ne(10));

Source

pub const fn signum(self) -> Self

Returns a number representing sign of self.

0 if the number is zero
1 if the number is positive
-1 if the number is negative

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i8>::from_ne(10).signum().to_ne(), 1);
assert_eq!(Be::<i8>::from_ne(0).signum().to_ne(), 0);
assert_eq!(Be::<i8>::from_ne(-10).signum().to_ne(), -1);

Source

pub const fn is_positive(self) -> bool

Returns true if self is positive and false if the number is zero or negative.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<i8>::from_ne(10).is_positive());
assert!(!Be::<i8>::from_ne(-10).is_positive());

Source

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is zero or positive.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<i8>::from_ne(-10).is_negative());
assert!(!Be::<i8>::from_ne(10).is_negative());

Source

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0b100_0000i8);

assert_eq!(n.count_ones(), 1);

Source

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i8>::MAX.count_zeros(), 1);

Source

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i8>::from_ne(-1);

assert_eq!(n.leading_zeros(), 0);

Source

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i8>::from_ne(-4);

assert_eq!(n.trailing_zeros(), 2);

Source §

impl Be<i16>

Source

pub const fn abs(self) -> Self

Computes the absolute value of self.

See i16::abs for documentation on overflow behavior.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i16>::from_ne(10).abs(), Be::<i16>::from_ne(10));
assert_eq!(Be::<i16>::from_ne(-10).abs(), Be::<i16>::from_ne(10));

Source

pub const fn signum(self) -> Self

Returns a number representing sign of self.

0 if the number is zero
1 if the number is positive
-1 if the number is negative

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i16>::from_ne(10).signum().to_ne(), 1);
assert_eq!(Be::<i16>::from_ne(0).signum().to_ne(), 0);
assert_eq!(Be::<i16>::from_ne(-10).signum().to_ne(), -1);

Source

pub const fn is_positive(self) -> bool

Returns true if self is positive and false if the number is zero or negative.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<i16>::from_ne(10).is_positive());
assert!(!Be::<i16>::from_ne(-10).is_positive());

Source

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is zero or positive.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<i16>::from_ne(-10).is_negative());
assert!(!Be::<i16>::from_ne(10).is_negative());

Source

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0b100_0000i16);

assert_eq!(n.count_ones(), 1);

Source

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i16>::MAX.count_zeros(), 1);

Source

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i16>::from_ne(-1);

assert_eq!(n.leading_zeros(), 0);

Source

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i16>::from_ne(-4);

assert_eq!(n.trailing_zeros(), 2);

Source §

impl Be<i32>

Source

pub const fn abs(self) -> Self

Computes the absolute value of self.

See i32::abs for documentation on overflow behavior.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i32>::from_ne(10).abs(), Be::<i32>::from_ne(10));
assert_eq!(Be::<i32>::from_ne(-10).abs(), Be::<i32>::from_ne(10));

Source

pub const fn signum(self) -> Self

Returns a number representing sign of self.

0 if the number is zero
1 if the number is positive
-1 if the number is negative

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i32>::from_ne(10).signum().to_ne(), 1);
assert_eq!(Be::<i32>::from_ne(0).signum().to_ne(), 0);
assert_eq!(Be::<i32>::from_ne(-10).signum().to_ne(), -1);

Source

pub const fn is_positive(self) -> bool

Returns true if self is positive and false if the number is zero or negative.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<i32>::from_ne(10).is_positive());
assert!(!Be::<i32>::from_ne(-10).is_positive());

Source

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is zero or positive.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<i32>::from_ne(-10).is_negative());
assert!(!Be::<i32>::from_ne(10).is_negative());

Source

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0b100_0000i32);

assert_eq!(n.count_ones(), 1);

Source

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i32>::MAX.count_zeros(), 1);

Source

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i32>::from_ne(-1);

assert_eq!(n.leading_zeros(), 0);

Source

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i32>::from_ne(-4);

assert_eq!(n.trailing_zeros(), 2);

Source §

impl Be<i64>

Source

pub const fn abs(self) -> Self

Computes the absolute value of self.

See i64::abs for documentation on overflow behavior.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i64>::from_ne(10).abs(), Be::<i64>::from_ne(10));
assert_eq!(Be::<i64>::from_ne(-10).abs(), Be::<i64>::from_ne(10));

Source

pub const fn signum(self) -> Self

Returns a number representing sign of self.

0 if the number is zero
1 if the number is positive
-1 if the number is negative

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i64>::from_ne(10).signum().to_ne(), 1);
assert_eq!(Be::<i64>::from_ne(0).signum().to_ne(), 0);
assert_eq!(Be::<i64>::from_ne(-10).signum().to_ne(), -1);

Source

pub const fn is_positive(self) -> bool

Returns true if self is positive and false if the number is zero or negative.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<i64>::from_ne(10).is_positive());
assert!(!Be::<i64>::from_ne(-10).is_positive());

Source

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is zero or positive.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<i64>::from_ne(-10).is_negative());
assert!(!Be::<i64>::from_ne(10).is_negative());

Source

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0b100_0000i64);

assert_eq!(n.count_ones(), 1);

Source

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i64>::MAX.count_zeros(), 1);

Source

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i64>::from_ne(-1);

assert_eq!(n.leading_zeros(), 0);

Source

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i64>::from_ne(-4);

assert_eq!(n.trailing_zeros(), 2);

Source §

impl Be<i128>

Source

pub const fn abs(self) -> Self

Computes the absolute value of self.

See i128::abs for documentation on overflow behavior.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i128>::from_ne(10).abs(), Be::<i128>::from_ne(10));
assert_eq!(Be::<i128>::from_ne(-10).abs(), Be::<i128>::from_ne(10));

Source

pub const fn signum(self) -> Self

Returns a number representing sign of self.

0 if the number is zero
1 if the number is positive
-1 if the number is negative

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i128>::from_ne(10).signum().to_ne(), 1);
assert_eq!(Be::<i128>::from_ne(0).signum().to_ne(), 0);
assert_eq!(Be::<i128>::from_ne(-10).signum().to_ne(), -1);

Source

pub const fn is_positive(self) -> bool

Returns true if self is positive and false if the number is zero or negative.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<i128>::from_ne(10).is_positive());
assert!(!Be::<i128>::from_ne(-10).is_positive());

Source

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is zero or positive.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<i128>::from_ne(-10).is_negative());
assert!(!Be::<i128>::from_ne(10).is_negative());

Source

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0b100_0000i128);

assert_eq!(n.count_ones(), 1);

Source

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<i128>::MAX.count_zeros(), 1);

Source

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i128>::from_ne(-1);

assert_eq!(n.leading_zeros(), 0);

Source

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<i128>::from_ne(-4);

assert_eq!(n.trailing_zeros(), 2);

Source §

impl Be<isize>

Source

pub const fn abs(self) -> Self

Computes the absolute value of self.

See isize::abs for documentation on overflow behavior.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<isize>::from_ne(10).abs(), Be::<isize>::from_ne(10));
assert_eq!(Be::<isize>::from_ne(-10).abs(), Be::<isize>::from_ne(10));

Source

pub const fn signum(self) -> Self

Returns a number representing sign of self.

0 if the number is zero
1 if the number is positive
-1 if the number is negative

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<isize>::from_ne(10).signum().to_ne(), 1);
assert_eq!(Be::<isize>::from_ne(0).signum().to_ne(), 0);
assert_eq!(Be::<isize>::from_ne(-10).signum().to_ne(), -1);

Source

pub const fn is_positive(self) -> bool

Returns true if self is positive and false if the number is zero or negative.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<isize>::from_ne(10).is_positive());
assert!(!Be::<isize>::from_ne(-10).is_positive());

Source

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is zero or positive.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<isize>::from_ne(-10).is_negative());
assert!(!Be::<isize>::from_ne(10).is_negative());

Source

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0b100_0000isize);

assert_eq!(n.count_ones(), 1);

Source

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<isize>::MAX.count_zeros(), 1);

Source

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<isize>::from_ne(-1);

assert_eq!(n.leading_zeros(), 0);

Source

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<isize>::from_ne(-4);

assert_eq!(n.trailing_zeros(), 2);

Source §

impl Be<u8>

Source

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0b01001100u8);

assert_eq!(n.count_ones(), 3);

Source

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<u8>::MAX.count_zeros(), 0);

Source

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u8>::from_ne(u8::MAX >> 2);

assert_eq!(n.leading_zeros(), 2);

Source

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u8>::from_ne(0b0101000);

assert_eq!(n.trailing_zeros(), 3);

Source

pub const fn is_power_of_two(self) -> bool

Returns true if and only if self == 2^k for some k.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<u8>::from_ne(16).is_power_of_two());
assert!(!Be::<u8>::from_ne(10).is_power_of_two());

Source §

impl Be<u16>

Source

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0b01001100u16);

assert_eq!(n.count_ones(), 3);

Source

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<u16>::MAX.count_zeros(), 0);

Source

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u16>::from_ne(u16::MAX >> 2);

assert_eq!(n.leading_zeros(), 2);

Source

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u16>::from_ne(0b0101000);

assert_eq!(n.trailing_zeros(), 3);

Source

pub const fn is_power_of_two(self) -> bool

Returns true if and only if self == 2^k for some k.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<u16>::from_ne(16).is_power_of_two());
assert!(!Be::<u16>::from_ne(10).is_power_of_two());

Source §

impl Be<u32>

Source

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0b01001100u32);

assert_eq!(n.count_ones(), 3);

Source

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<u32>::MAX.count_zeros(), 0);

Source

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u32>::from_ne(u32::MAX >> 2);

assert_eq!(n.leading_zeros(), 2);

Source

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u32>::from_ne(0b0101000);

assert_eq!(n.trailing_zeros(), 3);

Source

pub const fn is_power_of_two(self) -> bool

Returns true if and only if self == 2^k for some k.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<u32>::from_ne(16).is_power_of_two());
assert!(!Be::<u32>::from_ne(10).is_power_of_two());

Source §

impl Be<u64>

Source

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0b01001100u64);

assert_eq!(n.count_ones(), 3);

Source

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<u64>::MAX.count_zeros(), 0);

Source

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u64>::from_ne(u64::MAX >> 2);

assert_eq!(n.leading_zeros(), 2);

Source

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u64>::from_ne(0b0101000);

assert_eq!(n.trailing_zeros(), 3);

Source

pub const fn is_power_of_two(self) -> bool

Returns true if and only if self == 2^k for some k.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<u64>::from_ne(16).is_power_of_two());
assert!(!Be::<u64>::from_ne(10).is_power_of_two());

Source §

impl Be<u128>

Source

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0b01001100u128);

assert_eq!(n.count_ones(), 3);

Source

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<u128>::MAX.count_zeros(), 0);

Source

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u128>::from_ne(u128::MAX >> 2);

assert_eq!(n.leading_zeros(), 2);

Source

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<u128>::from_ne(0b0101000);

assert_eq!(n.trailing_zeros(), 3);

Source

pub const fn is_power_of_two(self) -> bool

Returns true if and only if self == 2^k for some k.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<u128>::from_ne(16).is_power_of_two());
assert!(!Be::<u128>::from_ne(10).is_power_of_two());

Source §

impl Be<usize>

Source

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be(0b01001100usize);

assert_eq!(n.count_ones(), 3);

Source

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

assert_eq!(Be::<usize>::MAX.count_zeros(), 0);

Source

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<usize>::from_ne(usize::MAX >> 2);

assert_eq!(n.leading_zeros(), 2);

Source

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

§Examples

Basic usage:

use endian_num::Be;

let n = Be::<usize>::from_ne(0b0101000);

assert_eq!(n.trailing_zeros(), 3);

Source

pub const fn is_power_of_two(self) -> bool

Returns true if and only if self == 2^k for some k.

§Examples

Basic usage:

use endian_num::Be;

assert!(Be::<usize>::from_ne(16).is_power_of_two());
assert!(!Be::<usize>::from_ne(10).is_power_of_two());

Source §

fn zero(&mut self)

Overwrites self with zeros. Read more

Source §

fn new_zeroed() -> Self
where Self: Sized,

Creates an instance of Self from zeroed bytes. Read more

Source §

impl<T: Hash> Hash for Be<T>

Source §

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

Source §

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Source §

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Source §

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Source §

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more

impl WriteHex for Be<usize>

Source §

fn write_hex<W: Write>(&self, writer: W) -> Result

Write the value as hex.

Source §

impl<T> StructuralPartialEq for Be<T>

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T, U> TryFrom for T
where U: Into<T>,

Source §

type Error = Infallible

The type returned in the event of a conversion error.

Source §

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct BeCopy item path

§Examples

Tuple Fields§

Implementations§

impl Be<u8>

pub const MIN: Self

§Examples

pub const MAX: Self

§Examples

pub const BITS: u32 = 8u32

§Examples

pub const fn from_ne(n: u8) -> Self

§Examples

pub const fn from_le(n: Le<u8>) -> Self

§Examples

pub const fn to_ne(self) -> u8

§Examples

pub const fn to_le(self) -> Le<u8>

§Examples

pub const fn to_be_bytes(self) -> [u8; 1]

§Examples

pub const fn to_le_bytes(self) -> [u8; 1]

§Examples

pub const fn to_ne_bytes(self) -> [u8; 1]

§Examples

pub const fn from_be_bytes(bytes: [u8; 1]) -> Self

§Examples

pub const fn from_le_bytes(bytes: [u8; 1]) -> Self

§Examples

pub const fn from_ne_bytes(bytes: [u8; 1]) -> Self

§Examples

pub const fn rotate_left(self, n: u32) -> Self

§Examples

pub const fn rotate_right(self, n: u32) -> Self

§Examples

pub const fn swap_bytes(self) -> Self

§Examples

pub const fn reverse_bits(self) -> Self

§Examples

pub const fn pow(self, exp: u32) -> Self

§Examples

impl Be<u16>

pub const MIN: Self

§Examples

pub const MAX: Self

§Examples

pub const BITS: u32 = 16u32

§Examples

pub const fn from_ne(n: u16) -> Self

§Examples

pub const fn from_le(n: Le<u16>) -> Self

§Examples

pub const fn to_ne(self) -> u16

§Examples

pub const fn to_le(self) -> Le<u16>

§Examples

pub const fn to_be_bytes(self) -> [u8; 2]

§Examples

pub const fn to_le_bytes(self) -> [u8; 2]

§Examples

pub const fn to_ne_bytes(self) -> [u8; 2]

§Examples

pub const fn from_be_bytes(bytes: [u8; 2]) -> Self

§Examples

pub const fn from_le_bytes(bytes: [u8; 2]) -> Self

§Examples

pub const fn from_ne_bytes(bytes: [u8; 2]) -> Self

§Examples

pub const fn rotate_left(self, n: u32) -> Self

§Examples

pub const fn rotate_right(self, n: u32) -> Self

§Examples

pub const fn swap_bytes(self) -> Self

§Examples

pub const fn reverse_bits(self) -> Self

§Examples

pub const fn pow(self, exp: u32) -> Self

§Examples

impl Be<u32>

pub const MIN: Self

Struct Be