Function winnow::binary::be_u24

source · 
pub fn be_u24<Input, Error>(input: &mut Input) -> PResult<u32, Error>
where
    Input: StreamIsPartial + Stream<Token = u8>,
    <Input as Stream>::Slice: AsBytes,
    Error: ParserError<Input>,
Expand description

Recognizes a big endian unsigned 3 byte 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::be_u24;

fn parser(s: &[u8]) -> IResult<&[u8], u32> {
    be_u24.parse_peek(s)
}

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

fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u32> {
    be_u24.parse_peek(s)
}

assert_eq!(parser(Partial::new(&b"\x00\x01\x02abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x000102)));
assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(2))));