imap-rs-core 0.2.3

Zero-copy IMAP4rev2 protocol types and parser (no I/O). Core of the imap-rs library.
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

//! Protocol core for the [`imap-rs`](https://crates.io/crates/imap-rs) library.
//!
//! `imap-rs-core` owns the IMAP4rev2 (RFC 9051) response model and a zero-copy,
//! hand-rolled recursive-descent parser. It performs **no I/O** and has no
//! network dependencies, which keeps it small and trivially testable.
//!
//! # Layout
//!
//! - [`ast`] — the typed response grammar ([`Response`], [`Status`], data
//!   responses, and `FETCH` attributes).
//! - [`parser`] — [`parse_response`], which turns a byte slice into a
//!   [`Response`], borrowing from the input where possible.
//! - [`error`] — [`ParseError`], the failure type returned by the parser.
//!
//! # Example
//!
//! ```
//! use imap_core::parser::parse_response;
//!
//! let input = b"* OK IMAP4rev2 Service Ready\r\n";
//! let (_rest, response) = parse_response(input).expect("valid greeting");
//! ```
#![forbid(unsafe_code)]

/// Typed IMAP4rev2 response grammar: [`Response`] and its constituents.
pub mod ast;
/// Parser failure type: [`ParseError`].
pub mod error;
/// Zero-copy response parser: [`parse_response`].
pub mod parser;

pub use ast::*;
pub use error::ParseError;
pub use parser::parse_response;