ircv3_parse 3.2.0

Zero-copy parser for IRCv3 messages
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

# IRCv3 Parse

[![CI](https://github.com/m3idnotfree/ircv3_parse/workflows/CI/badge.svg)](https://github.com/m3idnotfree/ircv3_parse/actions)
[![crates.io](https://img.shields.io/crates/v/ircv3_parse.svg)](https://crates.io/crates/ircv3_parse)
[![Documentation](https://docs.rs/ircv3_parse/badge.svg)](https://docs.rs/ircv3_parse)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/m3idnotfree/irc_parse/blob/main/LICENSE-MIT)
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/m3idnotfree/irc_parse/blob/main/LICENSE-APACHE)

A **zero-copy** IRC message parser with **IRCv3** support

[Documentation](https://docs.rs/ircv3_parse)

## Features

- Zero-copy parsing for performance
- IRCv3 message tags support
- **Derive macros** (`FromMessage`, `ToMessage`) for easy message extraction and generation
- `no_std` compatible (with `alloc`)

## Quick Start

```toml
[dependencies]
ircv3_parse = { version = "3", features = ["derive"] }
```

### Parsing Messages (FromMessage)

Extract IRC message components into your custom types with the `FromMessage` derive macro:

```rust
use ircv3_parse::FromMessage;

#[derive(FromMessage)]
#[irc(command = "PRIVMSG")]
struct PrivMsg<'a> {
    #[irc(source = "name")]
    nick: &'a str,
    #[irc(trailing)]
    message: &'a str
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let input = ":nick!user@example.com PRIVMSG #channel :hi";
    let msg: PrivMsg = ircv3_parse::from_str(input)?;

    // Output: From: nick
    println!("From: {}", msg.nick);
    // Output: Message: hi
    println!("Message: {}", msg.message);

    Ok(())
}
```

### Building Messages (ToMessage)

Generate IRC messages from your custom types with the `ToMessage` derive macro:

```rust
use ircv3_parse::ToMessage;

#[derive(ToMessage)]
#[irc(command = "PRIVMSG", crlf)]
struct PrivMsg<'a> {
    #[irc(tag)]
    msgid: &'a str,
    #[irc(param)]
    channel: &'a str,
    #[irc(trailing)]
    message: &'a str
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let msg = PrivMsg {
        msgid: "123",
        channel: "#channel",
        message: "hi"
    };

    let output = ircv3_parse::to_message(&msg)?;
    // Output: @msgid=123 PRIVMSG #channel :hi\r\n
    println!("{}", output);

    Ok(())
}
```

## Feature Flags

- **`std`** (default) - Standard library support
- **`derive`** - Enables `FromMessage` and `ToMessage` derive macros (recommended)
- **`serde`** - Enables `Serialize` implementation for `Message`

## `no_std` Support

```toml
[dependencies]
ircv3_parse = { version = "3", default-features = false, features = ["derive"] }
```

## Minimum Supported Rust Version (MSRV)

This crate requires **Rust 1.78 or later**.

## Parsing Rules

> **Notice:** Each component parses first special character and follows the rule. Use validation methods for strict parsing.

- **Tags**: Start with `@`, separated by `;`, followed by space
- **Source**: Start with `:`, format `name!user@host` or `host`, followed by space
- **Command**: Letters or 3-digit number
- **Middle Parameters**: Separated by spaces
- **Trailing Parameters**: Start with ` :` (space + colon)

## License

Licensed under either of:

- Apache License, Version 2.0
- MIT license