Struct trust_dns::op::message::Message

pub struct Message { /* fields omitted */ }

The basic request and response datastructure, used for all DNS protocols.

RFC 1035, DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION, November 1987

4.1. Format

All communications inside of the domain protocol are carried in a single
format called a message.  The top level format of message is divided
into 5 sections (some of which are empty in certain cases) shown below:

    +--------------------------+
    |        Header            |
    +--------------------------+
    |  Question / Zone         | the question for the name server
    +--------------------------+
    |   Answer  / Prerequisite | RRs answering the question
    +--------------------------+
    | Authority / Update       | RRs pointing toward an authority
    +--------------------------+
    |      Additional          | RRs holding additional information
    +--------------------------+

The header section is always present.  The header includes fields that
specify which of the remaining sections are present, and also specify
whether the message is a query or a response, a standard query or some
other opcode, etc.

The names of the sections after the header are derived from their use in
standard queries.  The question section contains fields that describe a
question to a name server.  These fields are a query type (QTYPE), a
query class (QCLASS), and a query domain name (QNAME).  The last three
sections have the same format: a possibly empty list of concatenated
resource records (RRs).  The answer section contains RRs that answer the
question; the authority section contains RRs that point toward an
authoritative name server; the additional records section contains RRs
which relate to the query, but are not strictly answers for the
question.

By default Message is a Query. Use the Message::as_update() to create and update, or Message::new_update()

Methods

impl Message

fn new() -> Self

Returns a new "empty" Message

fn error_msg(id: u16, op_code: OpCode, response_code: ResponseCode) -> Message

Returns a Message constructed with error details to return to a client

Arguments

• id - message id should match the request message id
• op_code - operation of the request
• response_code - the error code for the response

fn truncate(&self) -> Self

Truncates a Message, this blindly removes all response fields and sets trucation to true

fn set_id(&mut self, id: u16) -> &mut Self

see Header::set_id

fn set_message_type(&mut self, message_type: MessageType) -> &mut Self

see Header::set_message_type

fn set_op_code(&mut self, op_code: OpCode) -> &mut Self

see Header::set_op_code

fn set_authoritative(&mut self, authoritative: bool) -> &mut Self

see Header::set_authoritative

fn set_truncated(&mut self, truncated: bool) -> &mut Self

see Header::set_truncated

fn set_recursion_desired(&mut self, recursion_desired: bool) -> &mut Self

see Header::set_recursion_desired

fn set_recursion_available(&mut self, recursion_available: bool) -> &mut Self

see Header::set_recursion_available

fn set_authentic_data(&mut self, authentic_data: bool) -> &mut Self

see Header::set_authentic_data

fn set_checking_disabled(&mut self, checking_disabled: bool) -> &mut Self

see Header::set_checking_disabled

fn set_response_code(&mut self, response_code: ResponseCode) -> &mut Self

see Header::set_response_code

fn add_query(&mut self, query: Query) -> &mut Self

Add a query to the Message, either the query response from the server, or the request Query.

fn add_all_queries(&mut self, queries: &[Query]) -> &mut Self

Deprecated

Adds a slice of Queries to the message

fn add_queries<Q, I>(&mut self, queries: Q) -> &mut Self where
    Q: IntoIterator<Item = Query, IntoIter = I>,
    I: Iterator<Item = Query>, 

Adds an iterator over a set of Queries to be added to the message

fn add_answer(&mut self, record: Record) -> &mut Self

Add an answer to the Message

fn add_all_answers(&mut self, vector: &[&Record]) -> &mut Self

Deprecated

Add an entire set of Answers

fn add_answers<R, I>(&mut self, records: R) -> &mut Self where
    R: IntoIterator<Item = Record, IntoIter = I>,
    I: Iterator<Item = Record>, 

Add all the records from the iterator to the answers section of the Message

fn insert_answers(&mut self, records: Vec<Record>)

Sets the answers to the specified set of Records.

Panics

Will panic if answer records are already associated to the message.

fn add_name_server(&mut self, record: Record) -> &mut Self

Add a name server record to the Message

fn add_all_name_servers(&mut self, vector: &[&Record]) -> &mut Self

Deprecated

Adds a set of name server records to the message

fn add_name_servers<R, I>(&mut self, records: R) -> &mut Self where
    R: IntoIterator<Item = Record, IntoIter = I>,
    I: Iterator<Item = Record>, 

Add all the records in the Iterator to the name server section of the message

fn insert_name_servers(&mut self, records: Vec<Record>)

Sets the name_servers to the specified set of Records.

Panics

Will panic if name_servers records are already associated to the message.

fn add_additional(&mut self, record: Record) -> &mut Self

A an addtional Record to the message

fn insert_additionals(&mut self, records: Vec<Record>)

Sets the additional to the specified set of Records.

Panics

Will panic if additional records are already associated to the message.

fn set_edns(&mut self, edns: Edns) -> &mut Self

Add the EDNS section the the Message

fn add_sig0(&mut self, record: Record) -> &mut Self

Add a SIG0 record, i.e. sign this message

This must be don't only after all records have been associated. Generally this will be handled by the client and not need to be used directly

fn id(&self) -> u16

see Header::id()

fn message_type(&self) -> MessageType

see Header::message_type()

fn op_code(&self) -> OpCode

see Header::op_code()

fn authoritative(&self) -> bool

see Header::authoritative()

fn truncated(&self) -> bool

see Header::truncated()

fn recursion_desired(&self) -> bool

see Header::recursion_desired()

fn recursion_available(&self) -> bool

see Header::recursion_available()

fn authentic_data(&self) -> bool

see Header::authentic_data()

fn checking_disabled(&self) -> bool

see Header::checking_disabled()

fn response_code(&self) -> ResponseCode

Return value

The ResponseCode, if this is an EDNS message then this will join the section from the OPT record to create the EDNS ResponseCode

fn queries(&self) -> &[Query]

Question        Carries the query name and other query parameters.

fn answers(&self) -> &[Record]

Answer          Carries RRs which directly answer the query.

fn take_answers(&mut self) -> Vec<Record>

Removes all the answers from the Message

fn name_servers(&self) -> &[Record]

Authority       Carries RRs which describe other authoritative servers.
                May optionally carry the SOA RR for the authoritative
                data in the answer section.

fn take_name_servers(&mut self) -> Vec<Record>

Remove the name servers from the Message

fn additionals(&self) -> &[Record]

Additional      Carries RRs which may be helpful in using the RRs in the
                other sections.

fn take_additionals(&mut self) -> Vec<Record>

Remove the additional Records from the Message

fn edns(&self) -> Option<&Edns>

RFC 6891, EDNS(0) Extensions, April 2013

6.1.1.  Basic Elements

 An OPT pseudo-RR (sometimes called a meta-RR) MAY be added to the
 additional data section of a request.

 The OPT RR has RR type 41.

 If an OPT record is present in a received request, compliant
 responders MUST include an OPT record in their respective responses.

 An OPT record does not carry any DNS data.  It is used only to
 contain control information pertaining to the question-and-answer
 sequence of a specific transaction.  OPT RRs MUST NOT be cached,
 forwarded, or stored in or loaded from master files.

 The OPT RR MAY be placed anywhere within the additional data section.
 When an OPT RR is included within any DNS message, it MUST be the
 only OPT RR in that message.  If a query message with more than one
 OPT RR is received, a FORMERR (RCODE=1) MUST be returned.  The
 placement flexibility for the OPT RR does not override the need for
 the TSIG or SIG(0) RRs to be the last in the additional section
 whenever they are present.

Return value

Returns the EDNS record if it was found in the additional section.

fn edns_mut(&mut self) -> &mut Edns

If edns is_none, this will create a new default Edns.

fn max_payload(&self) -> u16

Return value

the max payload value as it's defined in the EDNS section.

fn version(&self) -> u8

Return value

the version as defined in the EDNS record

fn from_vec(buffer: &[u8]) -> DecodeResult<Message>

Decodes a message from the buffer.

fn to_vec(&self) -> Result<Vec<u8>, EncodeError>

Encodes the Message into a buffer

fn sign(&mut self, signer: &Signer, inception_time: u32) -> DnsSecResult<()>

Sign the message, i.e. add a SIG0 record to this Message.

Subsequent to calling this, the Message should not change.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Message

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for Message

fn eq(&self, __arg_0: &Message) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Message) -> bool

This method tests for !=.

impl UpdateMessage for Message

to reduce errors in using the Message struct as an Update, this will do the call throughs to properly do that.

fn id(&self) -> u16

see Header::id

fn add_zone(&mut self, query: Query)

Adds the zone section, i.e. name.example.com would be example.com

fn add_pre_requisite(&mut self, record: Record)

Add the pre-requisite records

fn add_all_pre_requisites(&mut self, vector: &[&Record])

Deprecated

Add all pre-requisites to the UpdateMessage

fn add_pre_requisites<R, I>(&mut self, records: R) where
    R: IntoIterator<Item = Record, IntoIter = I>,
    I: Iterator<Item = Record>, 

Add all the Records from the Iterator to the pre-reqisites section

fn add_update(&mut self, record: Record)

Add the Record to be updated

fn add_all_updates(&mut self, vector: &[&Record])

Deprecated

Add the set of Records to be updated

fn add_updates<R, I>(&mut self, records: R) where
    R: IntoIterator<Item = Record, IntoIter = I>,
    I: Iterator<Item = Record>, 

Add the Records from the Iterator to the updates section

fn add_additional(&mut self, record: Record)

Add Records to the additional Section of hte UpdateMessage

fn zones(&self) -> &[Query]

Returns the Zones to be updated, generally should only be one.

fn prerequisites(&self) -> &[Record]

Returns the pre-requisites

fn updates(&self) -> &[Record]

Returns the records to be updated

fn additionals(&self) -> &[Record]

Returns the additonal records

fn sig0(&self) -> &[Record]

This is used to authenticate update messages.

fn sign(&mut self, signer: &Signer, inception_time: u32) -> DnsSecResult<()>

Signs the UpdateMessage, used to validate the authenticity and authorization of UpdateMessage

impl BinSerializable<Message> for Message

fn read(decoder: &mut BinDecoder) -> DecodeResult<Self>

Read the type from the stream

fn emit(&self, encoder: &mut BinEncoder) -> EncodeResult

Write the type to the stream