curl_parser/
lib.rs

1//! A parser for converting curl commands into structured request objects.
2//!
3//! This crate provides functionality to parse curl command strings into a structured [`ParsedRequest`]
4//! that can be used programmatically. It's particularly useful for:
5//!
6//! - Converting curl commands into programmatic HTTP requests
7//! - Testing and debugging HTTP clients
8//! - Generating code from curl examples
9//!
10//! # Design Goals
11//!
12//! The main goals of this crate are:
13//!
14//! - **Accuracy**: Faithfully parse curl commands while preserving all relevant HTTP request details
15//! - **Ergonomics**: Provide a simple, intuitive API for parsing and using the results
16//! - **Flexibility**: Support common curl options while allowing for future extensibility
17//! - **Safety**: Handle malformed input gracefully with meaningful errors
18//!
19//! # Architecture
20//!
21//! The crate uses a multi-stage parsing approach:
22//!
23//! 1. **Lexical Analysis**: Uses Pest parser to tokenize the curl command string according to formal grammar rules
24//! 2. **Semantic Analysis**: Converts tokens into structured request components (method, headers, etc.)
25//! 3. **Request Building**: Assembles the components into a [`ParsedRequest`] struct
26//!
27//! The parser handles various curl options including:
28//! - HTTP methods (`-X`, `--request`)
29//! - Headers (`-H`, `--header`)
30//! - Request body (`-d`, `--data`)
31//! - Authentication (`-u`)
32//! - SSL verification (`-k`, `--insecure`)
33//! - URL redirection (`-L`, `--location`)
34//!
35//! # Examples
36//!
37//! Basic GET request:
38//!
39//! ```
40//! use curl_parser::ParsedRequest;
41//! use std::str::FromStr;
42//! # fn main() -> Result<(), curl_parser::Error> {
43//! let curl = r#"curl https://api.example.com/users"#;
44//! let request = ParsedRequest::from_str(curl)?;
45//! # Ok(())
46//! # }
47//! ```
48//!
49//! POST request with headers and body:
50//!
51//! ```
52//! use curl_parser::ParsedRequest;
53//! use serde_json::json;
54//! # fn main() -> Result<(), curl_parser::Error> {
55//! let curl = r#"curl -X POST https://api.example.com/users \
56//!     -H 'Content-Type: application/json' \
57//!     -H 'Authorization: Bearer {{ token }}' \
58//!     -d '{"name": "John Doe", "email": "john@example.com"}'"#;
59//! let request = ParsedRequest::load(curl, json!({ "token": "123456" }))?;
60//! # Ok(())
61//! # }
62//! ```
63//!
64//! Using with reqwest (requires `reqwest` feature):
65//!
66//! ```
67//! # #[cfg(feature = "reqwest")]
68//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
69//! use curl_parser::ParsedRequest;
70//! use serde_json::json;
71//!
72//! let curl = r#"curl -X POST https://api.example.com/users \
73//!     -H 'Authorization: Bearer {{ token }}' \
74//!     -d '{"name": "John Doe"}'"#;
75//!
76//! let parsed = ParsedRequest::load(curl, json!({ "token": "123456" }))?;
77//! let request = reqwest::RequestBuilder::try_from(&parsed)?;
78//! let response = request.send().await?;
79//! # Ok(())
80//! # }
81//! ```
82
83pub(crate) mod error;
84mod parser;
85
86#[cfg(feature = "uri")]
87use http::Uri;
88use http::{HeaderMap, Method};
89
90pub use error::Error;
91
92#[derive(Debug, Clone, Default)]
93pub struct ParsedRequest {
94    pub method: Method,
95    #[cfg(feature = "uri")]
96    pub url: Uri,
97    #[cfg(not(feature = "uri"))]
98    pub url: String,
99    pub headers: HeaderMap,
100    pub body: Vec<String>,
101    pub insecure: bool,
102}
curl_parser/lib.rs

curl_parser/
lib.rs
