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 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
use std::any::Any;
use std::any::TypeId;
use std::fmt;
use std::io::Read;
use std::io::Write;
#[cfg(feature = "bytes")]
use bytes::Bytes;
use crate::clear::Clear;
use crate::coded_input_stream::CodedInputStream;
use crate::coded_input_stream::WithCodedInputStream;
use crate::coded_output_stream::with_coded_output_stream_to_bytes;
use crate::coded_output_stream::CodedOutputStream;
use crate::coded_output_stream::WithCodedOutputStream;
use crate::error::ProtobufError;
use crate::error::ProtobufResult;
use crate::reflect::MessageDescriptor;
use crate::unknown::UnknownFields;
/// Trait implemented for all generated structs for protobuf messages.
///
/// Also, generated messages implement `Clone + Default + PartialEq`
pub trait Message: fmt::Debug + Clear + Any + Send + Sync {
/// Message descriptor for this message, used for reflection.
fn descriptor(&self) -> &'static MessageDescriptor;
/// True iff all required fields are initialized.
/// Always returns `true` for protobuf 3.
fn is_initialized(&self) -> bool;
/// Update this message object with fields read from given stream.
fn merge_from(&mut self, is: &mut CodedInputStream) -> ProtobufResult<()>;
/// Parse message from stream.
fn parse_from(is: &mut CodedInputStream) -> ProtobufResult<Self>
where
Self: Sized,
{
let mut r: Self = Message::new();
r.merge_from(is)?;
r.check_initialized()?;
Ok(r)
}
/// Write message to the stream.
///
/// Sizes of this messages and nested messages must be cached
/// by calling `compute_size` prior to this call.
fn write_to_with_cached_sizes(&self, os: &mut CodedOutputStream) -> ProtobufResult<()>;
/// Compute and cache size of this message and all nested messages
fn compute_size(&self) -> u32;
/// Get size previously computed by `compute_size`.
fn get_cached_size(&self) -> u32;
/// Write the message to the stream.
///
/// Results in error if message is not fully initialized.
fn write_to(&self, os: &mut CodedOutputStream) -> ProtobufResult<()> {
self.check_initialized()?;
// cache sizes
self.compute_size();
// TODO: reserve additional
self.write_to_with_cached_sizes(os)?;
Ok(())
}
/// Write the message to the stream prepending the message with message length
/// encoded as varint.
fn write_length_delimited_to(&self, os: &mut CodedOutputStream) -> ProtobufResult<()> {
let size = self.compute_size();
os.write_raw_varint32(size)?;
self.write_to_with_cached_sizes(os)?;
// TODO: assert we've written same number of bytes as computed
Ok(())
}
/// Write the message to the vec, prepend the message with message length
/// encoded as varint.
fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> ProtobufResult<()> {
let mut os = CodedOutputStream::vec(vec);
self.write_length_delimited_to(&mut os)?;
os.flush()?;
Ok(())
}
/// Update this message object with fields read from given stream.
fn merge_from_bytes(&mut self, bytes: &[u8]) -> ProtobufResult<()> {
let mut is = CodedInputStream::from_bytes(bytes);
self.merge_from(&mut is)
}
/// Parse message from reader.
/// Parse stops on EOF or when error encountered.
fn parse_from_reader(reader: &mut dyn Read) -> ProtobufResult<Self>
where
Self: Sized,
{
let mut is = CodedInputStream::new(reader);
let r = Message::parse_from(&mut is)?;
is.check_eof()?;
Ok(r)
}
/// Parse message from byte array.
fn parse_from_bytes(bytes: &[u8]) -> ProtobufResult<Self>
where
Self: Sized,
{
let mut is = CodedInputStream::from_bytes(bytes);
let r = Message::parse_from(&mut is)?;
is.check_eof()?;
Ok(r)
}
/// Parse message from `Bytes` object.
/// Resulting message may share references to the passed bytes object.
#[cfg(feature = "bytes")]
fn parse_from_carllerche_bytes(bytes: &Bytes) -> ProtobufResult<Self>
where
Self: Sized,
{
let mut is = CodedInputStream::from_carllerche_bytes(bytes);
let r = Self::parse_from(&mut is)?;
is.check_eof()?;
Ok(r)
}
/// Check if all required fields of this object are initialized.
fn check_initialized(&self) -> ProtobufResult<()> {
if !self.is_initialized() {
Err(ProtobufError::message_not_initialized(
self.descriptor().name(),
))
} else {
Ok(())
}
}
/// Write the message to the writer.
fn write_to_writer(&self, w: &mut dyn Write) -> ProtobufResult<()> {
w.with_coded_output_stream(|os| self.write_to(os))
}
/// Write the message to bytes vec.
fn write_to_vec(&self, v: &mut Vec<u8>) -> ProtobufResult<()> {
v.with_coded_output_stream(|os| self.write_to(os))
}
/// Write the message to bytes vec.
fn write_to_bytes(&self) -> ProtobufResult<Vec<u8>> {
self.check_initialized()?;
let size = self.compute_size() as usize;
let mut v = Vec::with_capacity(size);
// skip zerofill
unsafe {
v.set_len(size);
}
{
let mut os = CodedOutputStream::bytes(&mut v);
self.write_to_with_cached_sizes(&mut os)?;
os.check_eof();
}
Ok(v)
}
/// Write the message to the writer, prepend the message with message length
/// encoded as varint.
fn write_length_delimited_to_writer(&self, w: &mut dyn Write) -> ProtobufResult<()> {
w.with_coded_output_stream(|os| self.write_length_delimited_to(os))
}
/// Write the message to the bytes vec, prepend the message with message length
/// encoded as varint.
fn write_length_delimited_to_bytes(&self) -> ProtobufResult<Vec<u8>> {
with_coded_output_stream_to_bytes(|os| self.write_length_delimited_to(os))
}
/// Get a reference to unknown fields.
fn get_unknown_fields<'s>(&'s self) -> &'s UnknownFields;
/// Get a mutable reference to unknown fields.
fn mut_unknown_fields<'s>(&'s mut self) -> &'s mut UnknownFields;
/// Get type id for downcasting.
fn type_id(&self) -> TypeId {
TypeId::of::<Self>()
}
/// View self as `Any`.
fn as_any(&self) -> &dyn Any;
/// View self as mutable `Any`.
fn as_any_mut(&mut self) -> &mut dyn Any {
panic!()
}
/// Convert boxed self to boxed `Any`.
fn into_any(self: Box<Self>) -> Box<dyn Any> {
panic!()
}
// Rust does not allow implementation of trait for trait:
// impl<M : Message> fmt::Debug for M {
// ...
// }
/// Create an empty message object.
///
///
/// ```
/// # use protobuf::Message;
/// # fn foo<MyMessage: Message>() {
/// let m = MyMessage::new();
/// # }
/// ```
fn new() -> Self
where
Self: Sized;
/// Get message descriptor for message type.
///
/// ```
/// # use protobuf::Message;
/// # fn foo<MyMessage: Message>() {
/// let descriptor = MyMessage::descriptor_static();
/// assert_eq!("MyMessage", descriptor.name());
/// # }
/// ```
fn descriptor_static() -> &'static MessageDescriptor
where
Self: Sized,
{
panic!(
"descriptor_static is not implemented for message, \
LITE_RUNTIME must be used"
);
}
/// Return a pointer to default immutable message with static lifetime.
///
/// ```
/// # use protobuf::Message;
/// # fn foo<MyMessage: Message>() {
/// let m: &MyMessage = MyMessage::default_instance();
/// # }
/// ```
fn default_instance() -> &'static Self
where
Self: Sized;
}
pub fn message_down_cast<'a, M: Message + 'a>(m: &'a dyn Message) -> &'a M {
m.as_any().downcast_ref::<M>().unwrap()
}
/// Parse message from reader.
/// Parse stops on EOF or when error encountered.
#[deprecated(since = "2.19", note = "Use Message::parse_from_reader instead")]
pub fn parse_from_reader<M: Message>(reader: &mut dyn Read) -> ProtobufResult<M> {
M::parse_from_reader(reader)
}
/// Parse message from byte array.
#[deprecated(since = "2.19", note = "Use Message::parse_from_bytes instead")]
pub fn parse_from_bytes<M: Message>(bytes: &[u8]) -> ProtobufResult<M> {
M::parse_from_bytes(bytes)
}
/// Parse message from `Bytes` object.
/// Resulting message may share references to the passed bytes object.
#[cfg(feature = "bytes")]
#[deprecated(
since = "2.19",
note = "Use Message::parse_from_carllerche_bytes instead"
)]
pub fn parse_from_carllerche_bytes<M: Message>(bytes: &Bytes) -> ProtobufResult<M> {
M::parse_from_carllerche_bytes(bytes)
}
/// Parse length-delimited message from stream.
///
/// Read varint length first, and read messages of that length then.
///
/// This function is deprecated and will be removed in the next major release.
#[deprecated]
pub fn parse_length_delimited_from<M: Message>(is: &mut CodedInputStream) -> ProtobufResult<M> {
is.read_message::<M>()
}
/// Parse length-delimited message from `Read`.
///
/// This function is deprecated and will be removed in the next major release.
#[deprecated]
pub fn parse_length_delimited_from_reader<M: Message>(r: &mut dyn Read) -> ProtobufResult<M> {
// TODO: wrong: we may read length first, and then read exact number of bytes needed
r.with_coded_input_stream(|is| is.read_message::<M>())
}
/// Parse length-delimited message from bytes.
///
/// This function is deprecated and will be removed in the next major release.
#[deprecated]
pub fn parse_length_delimited_from_bytes<M: Message>(bytes: &[u8]) -> ProtobufResult<M> {
bytes.with_coded_input_stream(|is| is.read_message::<M>())
}