Function winnow::binary::i24

source · 
pub fn i24<Input, Error>(endian: Endianness) -> impl Parser<Input, i32, Error>
where
    Input: StreamIsPartial + Stream<Token = u8>,
    Error: ParserError<Input>,
Expand description

Recognizes a signed 3 byte integer

If the parameter is winnow::binary::Endianness::Big, parse a big endian i24 integer, otherwise if winnow::binary::Endianness::Little parse a little endian i24 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::binary::i24;

let be_i24 = |s| {
    i24(winnow::binary::Endianness::Big).parse_peek(s)
};

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

let le_i24 = |s| {
    i24(winnow::binary::Endianness::Little).parse_peek(s)
};

assert_eq!(le_i24(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x050300)));
assert_eq!(le_i24(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
use winnow::binary::i24;

let be_i24 = |s| {
    i24::<_, InputError<_>>(winnow::binary::Endianness::Big).parse_peek(s)
};

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

let le_i24 = |s| {
    i24::<_, InputError<_>>(winnow::binary::Endianness::Little).parse_peek(s)
};

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