Function u24

pub fn u24<Input, Error>(endian: Endianness) -> impl Parser<Input, u32, Error>
where
    Input: StreamIsPartial + Stream<Token = u8>,
    Error: ParserError<Input>,

Recognizes an unsigned 3 byte integer

If the parameter is winnow::binary::Endianness::Big, parse a big endian u24 integer, otherwise if winnow::binary::Endianness::Little parse a little endian u24 integer.

Complete version: returns an error if there is not enough input data

[Partial version][crate::_topic::partial]: Will return Err(winnow::error::ErrMode::Incomplete(_)) if there is not enough data.

Example

use winnow::binary::u24;

fn be_u24(input: &mut &[u8]) -> ModalResult<u32> {
    u24(winnow::binary::Endianness::Big).parse_next(input)
};

assert_eq!(be_u24.parse_peek(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x000305)));
assert!(be_u24.parse_peek(&b"\x01"[..]).is_err());

fn le_u24(input: &mut &[u8]) -> ModalResult<u32> {
    u24(winnow::binary::Endianness::Little).parse_next(input)
};

assert_eq!(le_u24.parse_peek(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x050300)));
assert!(le_u24.parse_peek(&b"\x01"[..]).is_err());

use winnow::binary::u24;

fn be_u24(input: &mut Partial<&[u8]>) -> ModalResult<u32> {
    u24(winnow::binary::Endianness::Big).parse_next(input)
};

assert_eq!(be_u24.parse_peek(Partial::new(&b"\x00\x03\x05abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x000305)));
assert_eq!(be_u24.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(2))));

fn le_u24(input: &mut Partial<&[u8]>) -> ModalResult<u32> {
    u24(winnow::binary::Endianness::Little).parse_next(input)
};

assert_eq!(le_u24.parse_peek(Partial::new(&b"\x00\x03\x05abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x050300)));
assert_eq!(le_u24.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(2))));