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
// Copyright 2015-2021 Benjamin Fry <benjaminfry@me.com>
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
//! Operation code for queries, updates, and responses
use std::{convert::From, fmt};
use crate::error::*;
/// Operation code for queries, updates, and responses
///
/// [RFC 1035, DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION, November 1987](https://tools.ietf.org/html/rfc1035)
///
/// ```text
/// OPCODE A four bit field that specifies kind of query in this
/// message. This value is set by the originator of a query
/// and copied into the response. The values are:
///
/// 0 a standard query (QUERY)
///
/// 1 an inverse query (IQUERY)
///
/// 2 a server status request (STATUS)
///
/// 3-15 reserved for future use
/// ```
#[derive(Debug, PartialEq, Eq, PartialOrd, Copy, Clone, Hash)]
#[allow(dead_code)]
pub enum OpCode {
/// Query request [RFC 1035](https://tools.ietf.org/html/rfc1035)
Query,
/// Status message [RFC 1035](https://tools.ietf.org/html/rfc1035)
Status,
/// Notify of change [RFC 1996](https://tools.ietf.org/html/rfc1996)
Notify,
/// Update message [RFC 2136](https://tools.ietf.org/html/rfc2136)
Update,
}
impl fmt::Display for OpCode {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
let s = match self {
OpCode::Query => "QUERY",
OpCode::Status => "STATUS",
OpCode::Notify => "NOTIFY",
OpCode::Update => "UPDATE",
};
f.write_str(s)
}
}
/// Convert from `OpCode` to `u8`
///
/// ```
/// use std::convert::From;
/// use trust_dns_proto::op::op_code::OpCode;
///
/// let var: u8 = From::from(OpCode::Query);
/// assert_eq!(0, var);
///
/// let var: u8 = OpCode::Query.into();
/// assert_eq!(0, var);
/// ```
impl From<OpCode> for u8 {
fn from(rt: OpCode) -> Self {
match rt {
OpCode::Query => 0,
// 1 IQuery (Inverse Query, OBSOLETE) [RFC3425]
OpCode::Status => 2,
// 3 Unassigned
OpCode::Notify => 4,
OpCode::Update => 5,
// 6-15 Unassigned
}
}
}
/// Convert from `u8` to `OpCode`
///
/// ```
/// use std::convert::From;
/// use trust_dns_proto::op::op_code::OpCode;
///
/// let var: OpCode = OpCode::from_u8(0).unwrap();
/// assert_eq!(OpCode::Query, var);
/// ```
impl OpCode {
/// Decodes the binary value of the OpCode
pub fn from_u8(value: u8) -> ProtoResult<Self> {
match value {
0 => Ok(Self::Query),
2 => Ok(Self::Status),
4 => Ok(Self::Notify),
5 => Ok(Self::Update),
_ => Err(format!("unknown OpCode: {}", value).into()),
}
}
}