rsdns 0.23.0

DNS Client 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

use crate::{
    message::{
        RecordsSection,
        reader::{RecordMarker, RecordOffset},
    },
    names::DName,
    records::{Class, Type},
};

/// A resource record header.
///
/// The difference between [`RecordHeader`] and [`RecordHeaderRef`] is that the former uses a domain
/// name type which owns the domain name bytes, while the latter uses [`NameRef`] which instead
/// is a reference to the original message buffer. Unfortunately, rust still doesn't allow
/// these two types to be expressed as a single type with a generic name parameter.
///
/// [`RecordsReader`]: super::RecordsReader
/// [`RecordHeaderRef`]: super::RecordHeaderRef
/// [`NameRef`]: crate::message::reader::NameRef
#[allow(dead_code)]
pub struct RecordHeader<N: DName> {
    pub(crate) name: N,
    pub(crate) marker: RecordMarker,
}

impl<N: DName> RecordHeader<N> {
    /// Returns the name of the record.
    #[inline]
    pub fn name(&self) -> &N {
        &self.name
    }

    /// Returns the record' marker.
    #[inline]
    pub fn marker(&self) -> &RecordMarker {
        &self.marker
    }

    /// Returns the record's offset.
    #[inline]
    pub fn offset(&self) -> RecordOffset {
        self.marker.offset
    }

    /// Returns the record's Type.
    #[inline]
    pub fn rtype(&self) -> Type {
        self.marker.rtype
    }

    /// Returns the record's Class.
    #[inline]
    pub fn rclass(&self) -> Class {
        self.marker.rclass
    }

    /// Returns the record's TTL.
    #[inline]
    pub fn ttl(&self) -> u32 {
        self.marker.ttl
    }

    /// Returns the record's data length.
    #[inline]
    pub fn rdlen(&self) -> u16 {
        self.marker.rdlen
    }

    /// Returns the record's section.
    #[inline]
    pub fn section(&self) -> RecordsSection {
        self.marker.section
    }
}