vinezombie 0.3.1

A modular IRCv3 framework
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

//! Well-known values for IRC messages.
//!
//! This module contains a large number of zero-sized `structs` which can stand in for
//! specific values within IRC messages. Each of these implements [`Name`],
//! which provides most of the necessary structure. Some implement [`NameValued`],
//! which allows parsing a value out from the context the `Name` implementor can usually be
//! found in (e.g. an IRC message).
#![allow(non_camel_case_types)]

// Throughout this, we'll be doing the `from_unchecked(Bytes::from_str)` dance.
// This helps compilation times, as we trust ourselves.

pub mod cap;
pub mod cmd;
pub mod isupport;
mod types;

pub use types::*;

use crate::string::{Arg, Bytes, Nick};

/// The literal `"*"`.
///
/// This shows up pretty commonly in argument lists,
/// so this constant is provided for convenience.
/// It is occasionally also used as the first argument of numeric replies.
#[allow(clippy::declare_interior_mutable_const)]
pub const STAR: Nick<'static> = unsafe { Nick::from_unchecked(Bytes::from_str("*")) };

/// The literal `"+"`.
///
/// Used as a placeholder when a base64-encoded field is empty.
#[allow(clippy::declare_interior_mutable_const)]
pub const PLUS: Arg<'static> = unsafe { Arg::from_unchecked(Bytes::from_str("+")) };

/// Marker for tags that differentiate client-originated messages.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
pub enum ClientMsgKind {}

impl NameClass for ClientMsgKind {
    type Raw<'a> = crate::string::Cmd<'a>;
    type Union<'a> = crate::ircmsg::ClientMsg<'a>;
    fn get_tag<'a, 'b>(outer: &'a Self::Union<'b>) -> &'a Self::Raw<'b> {
        &outer.cmd
    }
    fn get_tag_mut<'a, 'b>(outer: &'a mut Self::Union<'b>) -> &'a mut Self::Raw<'b> {
        &mut outer.cmd
    }
}

/// Marker for tags that differentiate server-originated messages.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
pub enum ServerMsgKind {}

impl NameClass for ServerMsgKind {
    type Raw<'a> = crate::ircmsg::ServerMsgKindRaw<'a>;
    type Union<'a> = crate::ircmsg::ServerMsg<'a>;
    fn get_tag<'a, 'b>(outer: &'a Self::Union<'b>) -> &'a Self::Raw<'b> {
        &outer.kind
    }
    fn get_tag_mut<'a, 'b>(outer: &'a mut Self::Union<'b>) -> &'a mut Self::Raw<'b> {
        &mut outer.kind
    }
}

/// Marker for the key halves of ISUPPORT tags.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
pub enum ISupport {}

impl NameClass for ISupport {
    type Raw<'a> = crate::string::Key<'a>;
    type Union<'a> = (Self::Raw<'a>, crate::string::Word<'a>);
    fn get_tag<'a, 'b>(outer: &'a Self::Union<'b>) -> &'a Self::Raw<'b> {
        &outer.0
    }
    fn get_tag_mut<'a, 'b>(outer: &'a mut Self::Union<'b>) -> &'a mut Self::Raw<'b> {
        &mut outer.0
    }
}

/// Marker for IRCv3 message tags.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
pub enum MsgTag {}

impl NameClass for MsgTag {
    type Raw<'a> = crate::string::Key<'a>;
    type Union<'a> = (Self::Raw<'a>, crate::string::NoNul<'a>);
    fn get_tag<'a, 'b>(outer: &'a Self::Union<'b>) -> &'a Self::Raw<'b> {
        &outer.0
    }
    fn get_tag_mut<'a, 'b>(outer: &'a mut Self::Union<'b>) -> &'a mut Self::Raw<'b> {
        &mut outer.0
    }
}

/// Marker for capabilities.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
pub enum Cap {}

impl NameClass for Cap {
    type Raw<'a> = crate::string::Key<'a>;
    type Union<'a> = (Self::Raw<'a>, crate::string::Word<'a>);
    fn get_tag<'a, 'b>(outer: &'a Self::Union<'b>) -> &'a Self::Raw<'b> {
        &outer.0
    }
    fn get_tag_mut<'a, 'b>(outer: &'a mut Self::Union<'b>) -> &'a mut Self::Raw<'b> {
        &mut outer.0
    }
}