gproxy_protocol/lib.rs
1//! # gproxy-protocol
2//!
3//! Wire format types and cross-protocol transforms for **Claude**, **OpenAI**, and **Gemini** LLM APIs.
4//!
5//! This crate provides two layers:
6//!
7//! 1. **Protocol types** — Serde-compatible request, response, and stream payload structs for each API.
8//! 2. **Transforms** — Cross-protocol converters that translate requests and responses between any pair of protocols.
9//!
10//! ## Protocol Modules
11//!
12//! | Module | API | Key Types |
13//! |--------|-----|-----------|
14//! | [`claude`] | Anthropic Messages API | `CreateMessageRequest`, `BetaMessage`, `ClaudeStreamEvent` |
15//! | [`openai`] | OpenAI Chat Completions & Responses API | `ChatCompletionRequest`, `ResponseBody`, `ChatCompletionChunk`, `ResponseStreamEvent` |
16//! | [`gemini`] | Google Gemini GenerateContent API | `GeminiGenerateContentRequest`, `GeminiGenerateContentResponse` |
17//!
18//! Each module follows the same internal structure:
19//! - `types.rs` — shared types and enums
20//! - `{operation}/request.rs` — request structs
21//! - `{operation}/response.rs` — response structs
22//! - `{operation}/stream.rs` — stream event payload types (no SSE/NDJSON framing)
23//!
24//! ## Deserializing a Request
25//!
26//! ```rust
27//! use gproxy_protocol::openai::create_chat_completions::request::RequestBody;
28//!
29//! let json = r#"{"model": "gpt-4", "messages": [{"role": "user", "content": "Hello"}]}"#;
30//! let body: RequestBody = serde_json::from_str(json).unwrap();
31//! assert_eq!(body.model, "gpt-4");
32//! ```
33//!
34//! ## Cross-Protocol Transforms
35//!
36//! The [`transform`] module converts between protocols using Rust's `TryFrom` trait.
37//! Transforms are organized as `transform::{source_protocol}::{operation}::{target_protocol}`.
38//!
39//! ### Non-streaming request conversion
40//!
41//! ```rust
42//! use gproxy_protocol::claude::create_message::request::ClaudeCreateMessageRequest;
43//! use gproxy_protocol::openai::create_chat_completions::request::OpenAiChatCompletionsRequest;
44//!
45//! // Claude request → OpenAI ChatCompletions request
46//! fn convert(claude_req: ClaudeCreateMessageRequest) -> Result<OpenAiChatCompletionsRequest, gproxy_protocol::transform::TransformError> {
47//! OpenAiChatCompletionsRequest::try_from(claude_req)
48//! }
49//! ```
50//!
51//! ### Streaming response conversion (buffer reuse pattern)
52//!
53//! Stream converters process chunks one at a time. The caller provides a reusable
54//! `Vec` buffer to avoid per-chunk heap allocation:
55//!
56//! ```rust,ignore
57//! use gproxy_protocol::openai::create_chat_completions::stream::ChatCompletionChunk;
58//! use gproxy_protocol::claude::create_message::stream::ClaudeStreamEvent;
59//! use gproxy_protocol::transform::claude::stream_generate_content::openai_chat_completions::response::OpenAiChatCompletionsToClaudeStream;
60//!
61//! let mut converter = OpenAiChatCompletionsToClaudeStream::default();
62//! let mut buf: Vec<ClaudeStreamEvent> = Vec::new();
63//!
64//! // For each incoming chunk from upstream:
65//! // converter.on_chunk(chunk, &mut buf);
66//! // buf now contains 0..N output events — forward them, then clear:
67//! // for event in buf.drain(..) { send_downstream(event); }
68//!
69//! // When the upstream stream ends:
70//! // converter.finish(&mut buf);
71//! // forward remaining events in buf
72//! ```
73//!
74//! ## SSE-to-NDJSON Rewriter
75//!
76//! The [`stream`] module provides an incremental SSE-to-NDJSON byte converter,
77//! useful when the downstream expects NDJSON but the internal pipeline uses SSE framing:
78//!
79//! ```rust
80//! use gproxy_protocol::stream::SseToNdjsonRewriter;
81//!
82//! let mut rewriter = SseToNdjsonRewriter::default();
83//! let out = rewriter.push_chunk(b"data: {\"text\":\"hi\"}\n\n");
84//! assert_eq!(out, b"{\"text\":\"hi\"}\n");
85//! ```
86
87pub mod claude;
88pub mod gemini;
89pub mod kinds;
90pub mod openai;
91
92pub use kinds::{OperationFamily, ProtocolKind};
93
94pub mod stream;
95pub mod transform;