nonymous 0.7.0

DNS protocol and algorithm library
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
122
123
124
125
126
127
128

//! Strongly typed RDATA access, across both views and owned types.
//!
//! ```
//! # #[macro_use] extern crate nonymous;
//! # declare_any_error!(AnyError);
//! use nonymous::rdata::A;
//! use nonymous::view::{Record, View};
//! use nonymous::fmt::Plain;
//! let record = b"\0\x00\x01\x00\x01\0\0\0\0\x00\x04\xC0\x00\x02\x01";
//! let record = Record::view(record, ..)?.0;
//!
//! // Prints: 192.0.2.1
//! dbg!(record.rdata_as_view::<A>()?.to_ipv4_addr());
//! # Ok::<(), AnyError>(())
//! ```

pub mod view;

use crate::core::{Class, Type};
use crate::rdata::class::{GenericClass, InClass};
use crate::rdata::view::error::RdataError;
use crate::view::{View, ViewToOwned};

use core::marker::PhantomData;
use core::net::{Ipv4Addr, Ipv6Addr};

/// Any marker type that pairs a TYPE with a CLASS.
pub trait ClassType {
    const CLASS: Class;
    const TYPE: Type;
    type View<'s>: RdataView<'s>;
}
/// RDATA views must implement this trait, which is [`View`] with additional requirements.
pub trait RdataView<'s>: View<'s, Error = RdataError> {}

/// Marker type for NS records. Generic across all classes.
pub struct Ns<C: GenericClass = InClass>(PhantomData<C>);
impl<C: GenericClass> ClassType for Ns<C> {
    const CLASS: Class = C::CLASS;

    const TYPE: Type = Type::NS;

    type View<'s> = crate::rdata::view::Ns<'s>;
}
impl<'s> RdataView<'s> for crate::rdata::view::Ns<'s> {}
#[cfg(feature = "alloc")]
impl ViewToOwned<crate::name::NameBuf> for crate::rdata::view::Ns<'_> {
    fn to_owned(&self) -> crate::name::NameBuf {
        self.name().into()
    }
}

/// Marker type for CNAME records. Generic across all classes.
pub struct Cname<C: GenericClass = InClass>(PhantomData<C>);
impl<C: GenericClass> ClassType for Cname<C> {
    const CLASS: Class = C::CLASS;

    const TYPE: Type = Type::CNAME;

    type View<'s> = crate::rdata::view::Cname<'s>;
}
impl<'s> RdataView<'s> for crate::rdata::view::Cname<'s> {}
#[cfg(feature = "alloc")]
impl ViewToOwned<crate::name::NameBuf> for crate::rdata::view::Cname<'_> {
    fn to_owned(&self) -> crate::name::NameBuf {
        self.name().into()
    }
}

/// Marker type for PTR records. Generic across all classes.
pub struct Ptr<C: GenericClass = InClass>(PhantomData<C>);
impl<C: GenericClass> ClassType for Ptr<C> {
    const CLASS: Class = C::CLASS;

    const TYPE: Type = Type::PTR;

    type View<'s> = crate::rdata::view::Ptr<'s>;
}
impl<'s> RdataView<'s> for crate::rdata::view::Ptr<'s> {}
#[cfg(feature = "alloc")]
impl ViewToOwned<crate::name::NameBuf> for crate::rdata::view::Ptr<'_> {
    fn to_owned(&self) -> crate::name::NameBuf {
        self.name().into()
    }
}

/// Marker type for A records. Currently implemented for IN class only.
pub struct A<C: GenericClass = InClass>(PhantomData<C>);
impl ClassType for A<InClass> {
    const CLASS: Class = Class::IN;
    const TYPE: Type = Type::A;
    type View<'s> = crate::rdata::view::A<'s>;
}
impl<'s> RdataView<'s> for crate::rdata::view::A<'s> {}
impl ViewToOwned<Ipv4Addr> for crate::rdata::view::A<'_> {
    fn to_owned(&self) -> Ipv4Addr {
        self.to_ipv4_addr()
    }
}

/// Marker type for AAAA records. Currently implemented for IN class only.
pub struct Aaaa<C: GenericClass = InClass>(PhantomData<C>);
impl ClassType for Aaaa<InClass> {
    const CLASS: Class = Class::IN;
    const TYPE: Type = Type::AAAA;
    type View<'s> = crate::rdata::view::Aaaa<'s>;
}
impl<'s> RdataView<'s> for crate::rdata::view::Aaaa<'s> {}
impl ViewToOwned<Ipv6Addr> for crate::rdata::view::Aaaa<'_> {
    fn to_owned(&self) -> Ipv6Addr {
        self.to_ipv6_addr()
    }
}

/// Marker types for CLASSes, such as the [`InClass`].
pub mod class {
    use crate::core::Class;

    pub trait GenericClass {
        const CLASS: Class;
    }

    #[derive(Clone, Debug)]
    pub struct InClass;
    impl GenericClass for InClass {
        const CLASS: Class = Class::IN;
    }
}