Function winnow::number::u24

source ·
pub fn u24<I, E: ParseError<I>>(endian: Endianness) -> impl Parser<I, u32, E>where
    I: StreamIsPartial + Stream<Token = u8>,
    <I as Stream>::Slice: AsBytes,
Expand description

Recognizes an unsigned 3 byte integer

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

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

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

Example

use winnow::number::u24;

let be_u24 = |s| {
    u24(winnow::number::Endianness::Big).parse_next(s)
};

assert_eq!(be_u24(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x000305)));
assert_eq!(be_u24(&b"\x01"[..]), Err(ErrMode::Backtrack(Error::new(&[0x01][..], ErrorKind::Slice))));

let le_u24 = |s| {
    u24(winnow::number::Endianness::Little).parse_next(s)
};

assert_eq!(le_u24(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x050300)));
assert_eq!(le_u24(&b"\x01"[..]), Err(ErrMode::Backtrack(Error::new(&[0x01][..], ErrorKind::Slice))));
use winnow::number::u24;

let be_u24 = |s| {
    u24::<_,Error<_>>(winnow::number::Endianness::Big).parse_next(s)
};

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

let le_u24 = |s| {
    u24::<_, Error<_>>(winnow::number::Endianness::Little).parse_next(s)
};

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