hickory-proto 0.26.0

hickory-proto is a safe and secure low-level DNS library. This is the foundational DNS protocol library used by the other higher-level Hickory DNS crates.
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

// Copyright 2015-2023 Benjamin Fry <benjaminfry@me.com>
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// https://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// https://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

//! Resource record related components, e.g. `Name` aka label, `Record`, `RData`, ...

use core::fmt::{Debug, Display};

use crate::serialize::binary::{BinDecodable, BinDecoder, BinEncodable, DecodeError, Restrict};

pub(crate) mod dns_class;
pub use dns_class::DNSClass;

pub mod domain;
pub use domain::{IntoName, Label, Name};

mod lower_name;
pub use lower_name::LowerName;

pub mod rdata;

pub(crate) mod record;
pub use record::{Record, RecordRef};

pub(crate) mod record_data;
pub use record_data::RData;

pub(crate) mod record_type;
pub use record_type::RecordType;

pub(crate) mod record_type_set;
pub use record_type_set::RecordTypeSet;

mod rr_key;
pub use rr_key::RrKey;

mod rr_set;
#[cfg(feature = "__dnssec")]
pub use rr_set::RecordsAndRrsigsIter;
pub use rr_set::{RecordSet, RecordSetParts, RrsetRecords};

pub(crate) mod serial_number;
pub use serial_number::SerialNumber;

mod tsig;
#[cfg(feature = "__dnssec")]
pub use tsig::TSigVerifier;
pub use tsig::{TSigResponseContext, TSigner};

/// RecordData that is stored in a DNS Record.
///
/// This trait allows for generic usage of `RecordData` types inside the `Record` type. Specific RecordData types can be used to enforce compile time constraints on a Record.
pub trait RecordData: Clone + Sized + PartialEq + Eq + Display + Debug + BinEncodable {
    /// Attempts to borrow this RecordData from the RData type, if it is not the correct type the original is returned
    fn try_borrow(data: &RData) -> Option<&Self>;

    /// Get the associated RecordType for the RecordData
    fn record_type(&self) -> RecordType;

    /// Converts this RecordData into generic RecordData
    fn into_rdata(self) -> RData;

    /// RDLENGTH = 0
    fn is_update(&self) -> bool {
        false
    }
}

pub(crate) trait RecordDataDecodable<'r>: Sized {
    /// Read the RecordData from the data stream.
    ///
    /// * `decoder` - data stream from which the RData will be read
    /// * `record_type` - specifies the RecordType that has already been read from the stream
    /// * `length` - the data length that should be read from the stream for this RecordData
    fn read_data(decoder: &mut BinDecoder<'r>, length: Restrict<u16>) -> Result<Self, DecodeError>;
}

impl<'r, T> RecordDataDecodable<'r> for T
where
    T: 'r + BinDecodable<'r> + Sized,
{
    fn read_data(
        decoder: &mut BinDecoder<'r>,
        _length: Restrict<u16>,
    ) -> Result<Self, DecodeError> {
        T::read(decoder)
    }
}