Function till_line_ending

fn till_line_ending<Input, Error>(input: &mut Input) -> Result<<Input as Stream>::Slice, Error>
where
    Input: StreamIsPartial + Stream + Compare<&'static str> + FindSlice<(char, char)>,
    <Input as Stream>::Token: AsChar + Clone,
    Error: ParserError<Input>

Recognizes a string of 0+ characters until "\r\n", "\n", or eof.

Complete version: Will return an error if there's not enough input data.

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

Effective Signature

Assuming you are parsing a &str [Stream]:

# use winnow::prelude::*;;
pub fn till_line_ending<'i>(input: &mut &'i str) -> ModalResult<&'i str>
# {
#     winnow::ascii::till_line_ending.parse_next(input)
# }

Example

# use winnow::prelude::*;
# use winnow::ascii::till_line_ending;
fn parser<'s>(input: &mut &'s str) -> ModalResult<&'s str> {
    till_line_ending.parse_next(input)
}

assert_eq!(parser.parse_peek("ab\r\nc"), Ok(("\r\nc", "ab")));
assert_eq!(parser.parse_peek("ab\nc"), Ok(("\nc", "ab")));
assert_eq!(parser.parse_peek("abc"), Ok(("", "abc")));
assert_eq!(parser.parse_peek(""), Ok(("", "")));
assert!(parser.parse_peek("a\rb\nc").is_err());
assert!(parser.parse_peek("a\rbc").is_err());

# use winnow::prelude::*;
# use winnow::{error::ErrMode, error::ContextError, error::Needed};
# use winnow::Partial;
# use winnow::ascii::till_line_ending;
assert_eq!(till_line_ending::<_, ErrMode<ContextError>>.parse_peek(Partial::new("ab\r\nc")), Ok((Partial::new("\r\nc"), "ab")));
assert_eq!(till_line_ending::<_, ErrMode<ContextError>>.parse_peek(Partial::new("abc")), Err(ErrMode::Incomplete(Needed::Unknown)));
assert_eq!(till_line_ending::<_, ErrMode<ContextError>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::Unknown)));
assert!(till_line_ending::<_, ErrMode<ContextError>>.parse_peek(Partial::new("a\rb\nc")).is_err());
assert!(till_line_ending::<_, ErrMode<ContextError>>.parse_peek(Partial::new("a\rbc")).is_err());