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 2019 The Tari Project
//
//  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
//  following conditions are met:
//
//  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
//  disclaimer.
//
//  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
//  following disclaimer in the documentation and/or other materials provided with the distribution.
//
//  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
//  products derived from this software without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
//  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
//  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

//! # Message
//!
//! The message module contains the message types which wrap domain-level messages.
//!
//! Described further in [RFC-0172](https://rfc.tari.com/RFC-0172_PeerToPeerMessagingProtocol.html#messaging-structure)
//!
//! - [Frame] and [FrameSet]
//!
//! A [FrameSet] consists of multiple [Frame]s. A [Frame] is the raw byte representation of a message.
//!
//! - [MessageEnvelope]
//!
//! Represents data that is about to go on the wire or has just come off.
//!
//! - [MessageEnvelopeHeader]
//!
//! The header that every message contains.
//!
//! - [Message]
//!
//! This message is deserialized from the body [Frame] of the [MessageEnvelope].
//! It consists of a [MessageHeader] and a domain-level body [Frame].
//! This part of the [MessageEnvelope] can optionally be encrypted for a particular peer.
//!
//! - [MessageHeader]
//!
//! Information about the contained message. Currently, this only contains the
//! domain-level message type.
//!
//! - [MessageData]
//!
//! [Frame]: ./tyoe.Frame.html
//! [FrameSet]: ./tyoe.FrameSet.html
//! [MessageEnvelope]: ./envelope/struct.MessageEnvelope.html
//! [MessageEnvelopeHeader]: ./envelope/struct.MessageEnvelopeHeader.html
//! [Message]: ./message/struct.Message.html
//! [MessageHeader]: ./message/struct.MessageHeader.html
//! [MessageData]: ./message/struct.MessageData.html
//! [DomainConnector]: ../domain_connector/struct.DomainConnector.html

#[macro_use]
mod envelope;
pub use envelope::EnvelopeBody;

mod error;
pub use error::MessageError;

mod inbound;
pub use inbound::InboundMessage;

mod outbound;
pub use outbound::{MessagingReplyRx, MessagingReplyTx, OutboundMessage};

mod tag;
pub use tag::MessageTag;

pub trait MessageExt: prost::Message {
    /// Encodes a message, allocating the buffer on the heap as necessary
    fn to_encoded_bytes(&self) -> Vec<u8>
    where Self: Sized {
        let mut buf = Vec::with_capacity(self.encoded_len());
        self.encode(&mut buf).expect(
            "prost::Message::encode documentation says it is infallible unless the buffer has insufficient capacity. \
             This buffer's capacity was set with encoded_len",
        );
        buf
    }
}
impl<T: prost::Message> MessageExt for T {}