nom-rfc8288 0.2.1

A nom based parser for RFC 8288
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

//! This crate provides utilities for parsing `Link` headers. See the [complete::link] method
//! for more info

#![deny(rustdoc::broken_intra_doc_links)]

use nom::{error::ParseError, AsChar, IResult, Parser};

pub mod complete;
pub mod streaming;

/// Token character
///
/// TCHAR = "!" / "#" / "$" / "%" / "&" / "'" / "*"
///       / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~"
///       / DIGIT / ALPHA
pub fn is_tchar(c: impl AsChar) -> bool {
    // This is implemented as one match statement because to call
    // is_alpha and is_digit would impose the Copy trait on this
    // function call
    matches!(c.as_char(),
             '!' | '#' | '$' | '%' | '&' | '\'' | '*' |
             '+' | '-' | '.' | '^' | '_' | '`' | '|' | '~' |
             '\x41'..='\x5A' | '\x61'..='\x7A' | // A-Z, a-z
             '\x30'..='\x39' // Digits
    )
}

/// QDTEXT = HTAB / SP / %x21 / %x23-5B / %x5D-7E / obs-text
pub fn is_qdtext(c: impl AsChar) -> bool {
    matches!(c.as_char(), '\t' | ' ' | '\x21' | '\x23' ..= '\x5B' | '\x5D' ..= '\x7E' | '\u{80}' ..= '\u{FF}')
}

/// Only implements the ( HTAB / SP / VCHAR / obs-text ) component of QUOTED-PAIR
fn is_quoted_pair(c: impl AsChar) -> bool {
    // https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6
    matches!(c.as_char(), '\t' | ' ' | '\x21' ..= '\x7E' | '\u{80}' ..= '\u{FF}')
}

/// If the condition is true, this parser only returns `Some` or `None`
fn optional_parser<I, O, E, L>(
    condition: bool,
    mut element: L,
) -> impl FnMut(I) -> IResult<I, Option<O>, E>
where
    L: Parser<I, O, E>,
    E: ParseError<I>,
    I: Copy,
{
    move |input: I| {
        let res = element.parse(input);

        if condition {
            return Ok(match res {
                Ok((k, j)) => (k, Some(j)),
                Err(_) => (input, None),
            });
        }

        match res {
            Ok((k, j)) => Ok((k, Some(j))),
            Err(e) => Err(e),
        }
    }
}

#[doc = include_str!("../README.md")]
#[cfg(doctest)]
pub struct ReadmeDoctests;