/// Configurable endianness #[derive(Debug, PartialEq, Eq, Clone, Copy)] pubenum Endianness { /// Big endian
Big, /// Little endian
Little, /// Will match the host's endianness
Native,
}
/// Recognizes an unsigned 1 byte 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::be_u8; /// /// fn parser(s: &mut &[u8]) -> ModalResult<u8> { /// be_u8.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03abcefg"[..]), Ok((&b"\x03abcefg"[..], 0x00))); /// assert!(parser.parse_peek(&b""[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::be_u8; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<u8> { /// be_u8.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"\x01abcd"[..]), 0x00))); /// assert_eq!(parser.parse_peek(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(1)))); /// ``` #[inline(always)] pubfn be_u8<Input, Error>(input: &mut Input) -> Result<u8, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
u8(input)
}
/// Recognizes a big endian unsigned 2 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::be_u16; /// /// fn parser(s: &mut &[u8]) -> ModalResult<u16> { /// be_u16.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03abcefg"[..]), Ok((&b"abcefg"[..], 0x0003))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::be_u16; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<u16> { /// be_u16.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0001))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(1)))); /// ``` #[inline(always)] pubfn be_u16<Input, Error>(input: &mut Input) -> Result<u16, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("be_u16", move |input: &mut Input| be_uint(input, 2)).parse_next(input)
}
/// Recognizes a big endian unsigned 3 byte 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::be_u24; /// /// fn parser(s: &mut &[u8]) -> ModalResult<u32> { /// be_u24.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x000305))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::be_u24; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<u32> { /// be_u24.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x000102))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(2)))); /// ``` #[inline(always)] pubfn be_u24<Input, Error>(input: &mut Input) -> Result<u32, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("be_u23", move |input: &mut Input| be_uint(input, 3)).parse_next(input)
}
/// Recognizes a big endian unsigned 4 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::be_u32; /// /// fn parser(s: &mut &[u8]) -> ModalResult<u32> { /// be_u32.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03\x05\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x00030507))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::be_u32; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<u32> { /// be_u32.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02\x03abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x00010203))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(3)))); /// ``` #[inline(always)] pubfn be_u32<Input, Error>(input: &mut Input) -> Result<u32, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("be_u32", move |input: &mut Input| be_uint(input, 4)).parse_next(input)
}
/// Recognizes a big endian unsigned 8 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::be_u64; /// /// fn parser(s: &mut &[u8]) -> ModalResult<u64> { /// be_u64.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x0001020304050607))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::be_u64; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<u64> { /// be_u64.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0001020304050607))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(7)))); /// ``` #[inline(always)] pubfn be_u64<Input, Error>(input: &mut Input) -> Result<u64, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("be_u64", move |input: &mut Input| be_uint(input, 8)).parse_next(input)
}
/// Recognizes a big endian unsigned 16 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::be_u128; /// /// fn parser(s: &mut &[u8]) -> ModalResult<u128> { /// be_u128.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x00010203040506070001020304050607))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::be_u128; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<u128> { /// be_u128.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x10\x11\x12\x13\x14\x15abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x00010203040506070809101112131415))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(15)))); /// ``` #[inline(always)] pubfn be_u128<Input, Error>(input: &mut Input) -> Result<u128, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("be_u128", move |input: &mut Input| be_uint(input, 16)).parse_next(input)
}
#[inline] fn be_uint<Input, Uint, Error>(input: &mut Input, bound: usize) -> Result<Uint, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Uint: Default + Shl<u8, Output = Uint> + Add<Uint, Output = Uint> + From<u8>,
Error: ParserError<Input>,
{
debug_assert_ne!(bound, 1, "to_be_uint needs extra work to avoid overflow"); match input.offset_at(bound) {
Ok(offset) => { let res = to_be_uint(input, offset);
input.next_slice(offset);
Ok(res)
}
Err(e) if <Input as StreamIsPartial>::is_partial_supported() && input.is_partial() => {
Err(ParserError::incomplete(input, e))
}
Err(_needed) => Err(ParserError::from_input(input)),
}
}
#[inline] fn to_be_uint<Input, Uint>(number: &Input, offset: usize) -> Uint where
Input: Stream,
Uint: Default
+ Shl<u8, Output = Uint>
+ Add<Uint, Output = Uint>
+ From<<Input as Stream>::Token>,
{ letmut res = Uint::default(); for (_, byte) in number.iter_offsets().take(offset) {
res = (res << 8) + byte.into();
}
res
}
/// Recognizes a signed 1 byte 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::be_i8; /// /// fn parser(s: &mut &[u8]) -> ModalResult<i8> { /// be_i8.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03abcefg"[..]), Ok((&b"\x03abcefg"[..], 0x00))); /// assert!(parser.parse_peek(&b""[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::be_i8; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<i8> { /// be_i8.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"\x01abcd"[..]), 0x00))); /// assert_eq!(parser.parse_peek(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(1)))); /// ``` #[inline(always)] pubfn be_i8<Input, Error>(input: &mut Input) -> Result<i8, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
i8(input)
}
/// Recognizes a big endian signed 2 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::be_i16; /// /// fn parser(s: &mut &[u8]) -> ModalResult<i16> { /// be_i16.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03abcefg"[..]), Ok((&b"abcefg"[..], 0x0003))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::be_i16; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<i16> { /// be_i16.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0001))); /// assert_eq!(parser.parse_peek(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(2)))); /// ``` #[inline(always)] pubfn be_i16<Input, Error>(input: &mut Input) -> Result<i16, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("be_i16", move |input: &mut Input| {
be_uint::<_, u16, _>(input, 2).map(|n| n as i16)
})
.parse_next(input)
}
/// Recognizes a big endian signed 3 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::be_i24; /// /// fn parser(s: &mut &[u8]) -> ModalResult<i32> { /// be_i24.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x000305))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::be_i24; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<i32> { /// be_i24.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x000102))); /// assert_eq!(parser.parse_peek(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(3)))); /// ``` #[inline(always)] pubfn be_i24<Input, Error>(input: &mut Input) -> Result<i32, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("be_i24", move |input: &mut Input| {
be_uint::<_, u32, _>(input, 3).map(|n| { // Same as the unsigned version but we need to sign-extend manually here let n = if n & 0x80_00_00 != 0 {
(n | 0xff_00_00_00) as i32
} else {
n as i32
};
n
})
})
.parse_next(input)
}
/// Recognizes a big endian signed 4 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::be_i32; /// /// fn parser(s: &mut &[u8]) -> ModalResult<i32> { /// be_i32.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03\x05\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x00030507))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::be_i32; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<i32> { /// be_i32.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02\x03abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x00010203))); /// assert_eq!(parser.parse_peek(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(4)))); /// ``` #[inline(always)] pubfn be_i32<Input, Error>(input: &mut Input) -> Result<i32, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("be_i32", move |input: &mut Input| {
be_uint::<_, u32, _>(input, 4).map(|n| n as i32)
})
.parse_next(input)
}
/// Recognizes a big endian signed 8 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::be_i64; /// /// fn parser(s: &mut &[u8]) -> ModalResult<i64> { /// be_i64.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x0001020304050607))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::be_i64; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<i64> { /// be_i64.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0001020304050607))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(7)))); /// ``` #[inline(always)] pubfn be_i64<Input, Error>(input: &mut Input) -> Result<i64, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("be_i64", move |input: &mut Input| {
be_uint::<_, u64, _>(input, 8).map(|n| n as i64)
})
.parse_next(input)
}
/// Recognizes a big endian signed 16 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::be_i128; /// /// fn parser(s: &mut &[u8]) -> ModalResult<i128> { /// be_i128.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x00010203040506070001020304050607))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::be_i128; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<i128> { /// be_i128.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x10\x11\x12\x13\x14\x15abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x00010203040506070809101112131415))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(15)))); /// ``` #[inline(always)] pubfn be_i128<Input, Error>(input: &mut Input) -> Result<i128, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("be_i128", move |input: &mut Input| {
be_uint::<_, u128, _>(input, 16).map(|n| n as i128)
})
.parse_next(input)
}
/// Recognizes an unsigned 1 byte 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::le_u8; /// /// fn parser(s: &mut &[u8]) -> ModalResult<u8> { /// le_u8.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03abcefg"[..]), Ok((&b"\x03abcefg"[..], 0x00))); /// assert!(parser.parse_peek(&b""[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::le_u8; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<u8> { /// le_u8.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"\x01abcd"[..]), 0x00))); /// assert_eq!(parser.parse_peek(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(1)))); /// ``` #[inline(always)] pubfn le_u8<Input, Error>(input: &mut Input) -> Result<u8, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
u8(input)
}
/// Recognizes a little endian unsigned 2 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::le_u16; /// /// fn parser(s: &mut &[u8]) -> ModalResult<u16> { /// le_u16.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03abcefg"[..]), Ok((&b"abcefg"[..], 0x0300))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::le_u16; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<u16> { /// le_u16.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0100))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(1)))); /// ``` #[inline(always)] pubfn le_u16<Input, Error>(input: &mut Input) -> Result<u16, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("le_u16", move |input: &mut Input| le_uint(input, 2)).parse_next(input)
}
/// Recognizes a little endian unsigned 3 byte 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::le_u24; /// /// fn parser(s: &mut &[u8]) -> ModalResult<u32> { /// le_u24.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x050300))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::le_u24; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<u32> { /// le_u24.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x020100))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(2)))); /// ``` #[inline(always)] pubfn le_u24<Input, Error>(input: &mut Input) -> Result<u32, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("le_u24", move |input: &mut Input| le_uint(input, 3)).parse_next(input)
}
/// Recognizes a little endian unsigned 4 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::le_u32; /// /// fn parser(s: &mut &[u8]) -> ModalResult<u32> { /// le_u32.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03\x05\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x07050300))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::le_u32; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<u32> { /// le_u32.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02\x03abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x03020100))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(3)))); /// ``` #[inline(always)] pubfn le_u32<Input, Error>(input: &mut Input) -> Result<u32, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("le_u32", move |input: &mut Input| le_uint(input, 4)).parse_next(input)
}
/// Recognizes a little endian unsigned 8 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::le_u64; /// /// fn parser(s: &mut &[u8]) -> ModalResult<u64> { /// le_u64.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x0706050403020100))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::le_u64; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<u64> { /// le_u64.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0706050403020100))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(7)))); /// ``` #[inline(always)] pubfn le_u64<Input, Error>(input: &mut Input) -> Result<u64, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("le_u64", move |input: &mut Input| le_uint(input, 8)).parse_next(input)
}
/// Recognizes a little endian unsigned 16 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::le_u128; /// /// fn parser(s: &mut &[u8]) -> ModalResult<u128> { /// le_u128.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x07060504030201000706050403020100))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::le_u128; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<u128> { /// le_u128.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x10\x11\x12\x13\x14\x15abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x15141312111009080706050403020100))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(15)))); /// ``` #[inline(always)] pubfn le_u128<Input, Error>(input: &mut Input) -> Result<u128, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("le_u128", move |input: &mut Input| le_uint(input, 16)).parse_next(input)
}
#[inline] fn to_le_uint<Input, Uint>(number: &Input, offset: usize) -> Uint where
Input: Stream,
Uint: Default
+ Shl<u8, Output = Uint>
+ Add<Uint, Output = Uint>
+ From<<Input as Stream>::Token>,
{ letmut res = Uint::default(); for (index, byte) in number.iter_offsets().take(offset) {
res = res + (Uint::from(byte) << (8 * index as u8));
}
res
}
/// Recognizes a signed 1 byte 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::le_i8; /// /// fn parser(s: &mut &[u8]) -> ModalResult<i8> { /// le_i8.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03abcefg"[..]), Ok((&b"\x03abcefg"[..], 0x00))); /// assert!(parser.parse_peek(&b""[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::le_i8; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<i8> { /// le_i8.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"\x01abcd"[..]), 0x00))); /// assert_eq!(parser.parse_peek(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(1)))); /// ``` #[inline(always)] pubfn le_i8<Input, Error>(input: &mut Input) -> Result<i8, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
i8(input)
}
/// Recognizes a little endian signed 2 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::le_i16; /// /// fn parser(s: &mut &[u8]) -> ModalResult<i16> { /// le_i16.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03abcefg"[..]), Ok((&b"abcefg"[..], 0x0300))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::le_i16; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<i16> { /// le_i16.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0100))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(1)))); /// ``` #[inline(always)] pubfn le_i16<Input, Error>(input: &mut Input) -> Result<i16, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("le_i16", move |input: &mut Input| {
le_uint::<_, u16, _>(input, 2).map(|n| n as i16)
})
.parse_next(input)
}
/// Recognizes a little endian signed 3 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::le_i24; /// /// fn parser(s: &mut &[u8]) -> ModalResult<i32> { /// le_i24.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x050300))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::le_i24; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<i32> { /// le_i24.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x020100))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(2)))); /// ``` #[inline(always)] pubfn le_i24<Input, Error>(input: &mut Input) -> Result<i32, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("le_i24", move |input: &mut Input| {
le_uint::<_, u32, _>(input, 3).map(|n| { // Same as the unsigned version but we need to sign-extend manually here let n = if n & 0x80_00_00 != 0 {
(n | 0xff_00_00_00) as i32
} else {
n as i32
};
n
})
})
.parse_next(input)
}
/// Recognizes a little endian signed 4 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::le_i32; /// /// fn parser(s: &mut &[u8]) -> ModalResult<i32> { /// le_i32.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03\x05\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x07050300))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::le_i32; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<i32> { /// le_i32.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02\x03abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x03020100))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(3)))); /// ``` #[inline(always)] pubfn le_i32<Input, Error>(input: &mut Input) -> Result<i32, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("le_i32", move |input: &mut Input| {
le_uint::<_, u32, _>(input, 4).map(|n| n as i32)
})
.parse_next(input)
}
/// Recognizes a little endian signed 8 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::le_i64; /// /// fn parser(s: &mut &[u8]) -> ModalResult<i64> { /// le_i64.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x0706050403020100))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::le_i64; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<i64> { /// le_i64.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0706050403020100))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(7)))); /// ``` #[inline(always)] pubfn le_i64<Input, Error>(input: &mut Input) -> Result<i64, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("le_i64", move |input: &mut Input| {
le_uint::<_, u64, _>(input, 8).map(|n| n as i64)
})
.parse_next(input)
}
/// Recognizes a little endian signed 16 bytes 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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::le_i128; /// /// fn parser(s: &mut &[u8]) -> ModalResult<i128> { /// le_i128.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x07060504030201000706050403020100))); /// assert!(parser.parse_peek(&b"\x01"[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::Partial; /// use winnow::binary::le_i128; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<i128> { /// le_i128.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x10\x11\x12\x13\x14\x15abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x15141312111009080706050403020100))); /// assert_eq!(parser.parse_peek(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(15)))); /// ``` #[inline(always)] pubfn le_i128<Input, Error>(input: &mut Input) -> Result<i128, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("le_i128", move |input: &mut Input| {
le_uint::<_, u128, _>(input, 16).map(|n| n as i128)
})
.parse_next(input)
}
/// Recognizes an unsigned 1 byte integer /// /// <div class="warning"> /// /// **Note:** that endianness does not apply to 1 byte numbers. /// /// </div> /// /// *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 /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// use winnow::binary::u8; /// /// fn parser(s: &mut &[u8]) -> ModalResult<u8> { /// u8.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(&b"\x00\x03abcefg"[..]), Ok((&b"\x03abcefg"[..], 0x00))); /// assert!(parser.parse_peek(&b""[..]).is_err()); /// ``` /// /// ```rust /// # use winnow::{error::ErrMode, error::InputError, error::Needed}; /// # use winnow::prelude::*; /// # use winnow::error::Needed::Size; /// # use winnow::Partial; /// use winnow::binary::u8; /// /// fn parser(s: &mut Partial<&[u8]>) -> ModalResult<u8> { /// u8.parse_next(s) /// } /// /// assert_eq!(parser.parse_peek(Partial::new(&b"\x00\x03abcefg"[..])), Ok((Partial::new(&b"\x03abcefg"[..]), 0x00))); /// assert_eq!(parser.parse_peek(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(1)))); /// ``` #[inline(always)] pubfn u8<Input, Error>(input: &mut Input) -> Result<u8, Error> where
Input: StreamIsPartial + Stream<Token = u8>,
Error: ParserError<Input>,
{
trace("u8", move |input: &mut Input| { if <Input as StreamIsPartial>::is_partial_supported() {
u8_::<_, _, true>(input)
} else {
u8_::<_, _, false>(input)
}
})
.parse_next(input)
}
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung und die Messung sind noch experimentell.