pub trait Message: Debug + Clear + Any + Send + Sync {
Show 28 methods
// Required methods
fn descriptor(&self) -> &'static MessageDescriptor;
fn is_initialized(&self) -> bool;
fn merge_from(
&mut self,
is: &mut CodedInputStream<'_>
) -> Result<(), ProtobufError>;
fn write_to_with_cached_sizes(
&self,
os: &mut CodedOutputStream<'_>
) -> Result<(), ProtobufError>;
fn compute_size(&self) -> u32;
fn get_cached_size(&self) -> u32;
fn get_unknown_fields<'s>(&'s self) -> &'s UnknownFields;
fn mut_unknown_fields<'s>(&'s mut self) -> &'s mut UnknownFields;
fn as_any(&self) -> &(dyn Any + 'static);
fn new() -> Self
where Self: Sized;
fn default_instance() -> &'static Self
where Self: Sized;
// Provided methods
fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self, ProtobufError>
where Self: Sized { ... }
fn write_to(
&self,
os: &mut CodedOutputStream<'_>
) -> Result<(), ProtobufError> { ... }
fn write_length_delimited_to(
&self,
os: &mut CodedOutputStream<'_>
) -> Result<(), ProtobufError> { ... }
fn write_length_delimited_to_vec(
&self,
vec: &mut Vec<u8, Global>
) -> Result<(), ProtobufError> { ... }
fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<(), ProtobufError> { ... }
fn parse_from_reader(reader: &mut dyn Read) -> Result<Self, ProtobufError>
where Self: Sized { ... }
fn parse_from_bytes(bytes: &[u8]) -> Result<Self, ProtobufError>
where Self: Sized { ... }
fn check_initialized(&self) -> Result<(), ProtobufError> { ... }
fn write_to_writer(&self, w: &mut dyn Write) -> Result<(), ProtobufError> { ... }
fn write_to_vec(&self, v: &mut Vec<u8, Global>) -> Result<(), ProtobufError> { ... }
fn write_to_bytes(&self) -> Result<Vec<u8, Global>, ProtobufError> { ... }
fn write_length_delimited_to_writer(
&self,
w: &mut dyn Write
) -> Result<(), ProtobufError> { ... }
fn write_length_delimited_to_bytes(
&self
) -> Result<Vec<u8, Global>, ProtobufError> { ... }
fn type_id(&self) -> TypeId { ... }
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static) { ... }
fn into_any(self: Box<Self, Global>) -> Box<dyn Any, Global> { ... }
fn descriptor_static() -> &'static MessageDescriptor
where Self: Sized { ... }
}Expand description
Trait implemented for all generated structs for protobuf messages.
Also, generated messages implement Clone + Default + PartialEq
Required Methods§
sourcefn descriptor(&self) -> &'static MessageDescriptor
fn descriptor(&self) -> &'static MessageDescriptor
Message descriptor for this message, used for reflection.
sourcefn is_initialized(&self) -> bool
fn is_initialized(&self) -> bool
True iff all required fields are initialized.
Always returns true for protobuf 3.
sourcefn merge_from(
&mut self,
is: &mut CodedInputStream<'_>
) -> Result<(), ProtobufError>
fn merge_from( &mut self, is: &mut CodedInputStream<'_> ) -> Result<(), ProtobufError>
Update this message object with fields read from given stream.
sourcefn write_to_with_cached_sizes(
&self,
os: &mut CodedOutputStream<'_>
) -> Result<(), ProtobufError>
fn write_to_with_cached_sizes( &self, os: &mut CodedOutputStream<'_> ) -> Result<(), ProtobufError>
Write message to the stream.
Sizes of this messages and nested messages must be cached
by calling compute_size prior to this call.
sourcefn compute_size(&self) -> u32
fn compute_size(&self) -> u32
Compute and cache size of this message and all nested messages
sourcefn get_cached_size(&self) -> u32
fn get_cached_size(&self) -> u32
Get size previously computed by compute_size.
sourcefn get_unknown_fields<'s>(&'s self) -> &'s UnknownFields
fn get_unknown_fields<'s>(&'s self) -> &'s UnknownFields
Get a reference to unknown fields.
sourcefn mut_unknown_fields<'s>(&'s mut self) -> &'s mut UnknownFields
fn mut_unknown_fields<'s>(&'s mut self) -> &'s mut UnknownFields
Get a mutable reference to unknown fields.
sourcefn default_instance() -> &'static Selfwhere
Self: Sized,
fn default_instance() -> &'static Selfwhere Self: Sized,
Return a pointer to default immutable message with static lifetime.
let m: &MyMessage = MyMessage::default_instance();Provided Methods§
sourcefn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self, ProtobufError>where
Self: Sized,
fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self, ProtobufError>where Self: Sized,
Parse message from stream.
sourcefn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<(), ProtobufError>
fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<(), ProtobufError>
Write the message to the stream.
Results in error if message is not fully initialized.
sourcefn write_length_delimited_to(
&self,
os: &mut CodedOutputStream<'_>
) -> Result<(), ProtobufError>
fn write_length_delimited_to( &self, os: &mut CodedOutputStream<'_> ) -> Result<(), ProtobufError>
Write the message to the stream prepending the message with message length encoded as varint.
sourcefn write_length_delimited_to_vec(
&self,
vec: &mut Vec<u8, Global>
) -> Result<(), ProtobufError>
fn write_length_delimited_to_vec( &self, vec: &mut Vec<u8, Global> ) -> Result<(), ProtobufError>
Write the message to the vec, prepend the message with message length encoded as varint.
sourcefn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<(), ProtobufError>
fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<(), ProtobufError>
Update this message object with fields read from given stream.
sourcefn parse_from_reader(reader: &mut dyn Read) -> Result<Self, ProtobufError>where
Self: Sized,
fn parse_from_reader(reader: &mut dyn Read) -> Result<Self, ProtobufError>where Self: Sized,
Parse message from reader. Parse stops on EOF or when error encountered.
sourcefn parse_from_bytes(bytes: &[u8]) -> Result<Self, ProtobufError>where
Self: Sized,
fn parse_from_bytes(bytes: &[u8]) -> Result<Self, ProtobufError>where Self: Sized,
Parse message from byte array.
sourcefn check_initialized(&self) -> Result<(), ProtobufError>
fn check_initialized(&self) -> Result<(), ProtobufError>
Check if all required fields of this object are initialized.
sourcefn write_to_writer(&self, w: &mut dyn Write) -> Result<(), ProtobufError>
fn write_to_writer(&self, w: &mut dyn Write) -> Result<(), ProtobufError>
Write the message to the writer.
sourcefn write_to_vec(&self, v: &mut Vec<u8, Global>) -> Result<(), ProtobufError>
fn write_to_vec(&self, v: &mut Vec<u8, Global>) -> Result<(), ProtobufError>
Write the message to bytes vec.
sourcefn write_to_bytes(&self) -> Result<Vec<u8, Global>, ProtobufError>
fn write_to_bytes(&self) -> Result<Vec<u8, Global>, ProtobufError>
Write the message to bytes vec.
sourcefn write_length_delimited_to_writer(
&self,
w: &mut dyn Write
) -> Result<(), ProtobufError>
fn write_length_delimited_to_writer( &self, w: &mut dyn Write ) -> Result<(), ProtobufError>
Write the message to the writer, prepend the message with message length encoded as varint.
sourcefn write_length_delimited_to_bytes(
&self
) -> Result<Vec<u8, Global>, ProtobufError>
fn write_length_delimited_to_bytes( &self ) -> Result<Vec<u8, Global>, ProtobufError>
Write the message to the bytes vec, prepend the message with message length encoded as varint.
sourcefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
View self as mutable Any.
sourcefn descriptor_static() -> &'static MessageDescriptorwhere
Self: Sized,
fn descriptor_static() -> &'static MessageDescriptorwhere Self: Sized,
Get message descriptor for message type.
let descriptor = MyMessage::descriptor_static();
assert_eq!("MyMessage", descriptor.name());