Function `line_ending`

fn line_ending<Input, Error>(input: &mut Input) -> Result<<Input as Stream>::Slice, Error>
where
    Input: StreamIsPartial + Stream + Compare<&'static str>,
    Error: ParserError<Input>

Recognizes an end of line (both "\n" and "\r\n").

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 line_ending<'i>(input: &mut &'i str) -> ModalResult<&'i str>
# {
#     winnow::ascii::line_ending.parse_next(input)
# }

Example

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

assert_eq!(parser.parse_peek("\r\nc"), Ok(("c", "\r\n")));
assert!(parser.parse_peek("ab\r\nc").is_err());
assert!(parser.parse_peek("").is_err());

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