irc-rust

IRC Helper easing the access and creation of IRC Messages. Minimum supported rust version (MRSV) is 1.40.0.

Github-actions runs build, check, fmt, clippy and test against the latest stable, nightly and 1.40.0 rust toolchains.

Table of Contents

• Installation
• Basic Usage
• Benchmarks
• Contributions

Installation

Requirements:

• Install nightly Rust toolchain:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none -y
.rustup.rs | sh

Installation:

• Add to Cargo.toml:

[dependencies]
irc-rust = "0.4"

• Or use cargo edit to get the latest every time:

cargo install cargo-edit
cargo add irc-rust # In your project root

Basic Usage

use irc_rust::Message;

fn main() {
    let message = Message::from("@key1=value1;key2=value2 :name!user@host CMD param1 param2 :trailing");
    
    assert_eq!(message.to_string(), "@key1=value1;key2=value2 :name!user@host CMD param1 param2 :trailing");
}

Benchmarks

Benchmark results are uploaded to github-pages automatically on push to master: https://moblaa.github.io/irc_rust/dev/bench/

The code for the benchmarks is located in the bench subdirectory.

Contributions

If you have any suggestion may it be refactorings of the code or benchmarks, have a feature request or something else, feel free to open an issue or pull request so we can discuss.

This is my first open source library, so I'm also open for advise on how to manage this repository.