Trait Message

pub trait Message:
    Default
    + Clone
    + Send
    + Sync
    + Sized
    + PartialEq
    + 'static {
    const NAME: &'static str;

    // Required methods
    fn is_initialized(&self) -> bool;
    fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>;
    fn write_to_with_cached_sizes(
        &self,
        os: &mut CodedOutputStream<'_>,
    ) -> Result<()>;
    fn compute_size(&self) -> u64;
    fn special_fields(&self) -> &SpecialFields;
    fn mut_special_fields(&mut self) -> &mut SpecialFields;
    fn new() -> Self;
    fn default_instance() -> &'static Self;

    // Provided methods
    fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self> { ... }
    fn cached_size(&self) -> u32 { ... }
    fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<()> { ... }
    fn write_length_delimited_to(
        &self,
        os: &mut CodedOutputStream<'_>,
    ) -> Result<()> { ... }
    fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<()> { ... }
    fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<()> { ... }
    fn parse_from_reader(reader: &mut dyn Read) -> Result<Self> { ... }
    fn parse_from_bytes(bytes: &[u8]) -> Result<Self> { ... }
    fn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self> { ... }
    fn check_initialized(&self) -> Result<()> { ... }
    fn write_to_writer(&self, w: &mut dyn Write) -> Result<()> { ... }
    fn write_to_vec(&self, v: &mut Vec<u8>) -> Result<()> { ... }
    fn write_to_bytes(&self) -> Result<Vec<u8>> { ... }
    fn write_length_delimited_to_writer(&self, w: &mut dyn Write) -> Result<()> { ... }
    fn write_length_delimited_to_bytes(&self) -> Result<Vec<u8>> { ... }
    fn unknown_fields(&self) -> &UnknownFields { ... }
    fn mut_unknown_fields(&mut self) -> &mut UnknownFields { ... }
    fn clear(&mut self) { ... }
}

Trait which is implemented by all generated message.

Note, by default all generated messages also implement MessageFull trait which provides access to reflection and features which depend on reflection (text format and JSON serialization).

Required Associated Constants

const NAME: &'static str

Message name as specified in .proto file.

Message name can be accessed using MessageFull::descriptor, but when lite runtime is requested, this field can be used.

Required Methods

fn is_initialized(&self) -> bool

True iff all required fields are initialized. Always returns true for protobuf 3.

fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>

Update this message object with fields read from given stream.

fn write_to_with_cached_sizes( &self, os: &mut CodedOutputStream<'_>, ) -> Result<()>

Write message to the stream.

Sizes of this messages and nested messages must be cached by calling compute_size prior to this call.

fn compute_size(&self) -> u64

Compute and cache size of this message and all nested messages.

Note if the computation overflows u32, the cached size is stored truncated.

fn special_fields(&self) -> &SpecialFields

Special fields (unknown fields and cached size).

fn mut_special_fields(&mut self) -> &mut SpecialFields

Special fields (unknown fields and cached size).

fn new() -> Self

Create an empty message object.

let m = MyMessage::new();

fn default_instance() -> &'static Self

Return a pointer to default immutable message with static lifetime.

let m: &MyMessage = MyMessage::default_instance();

Provided Methods

fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self>

Parse message from stream.

fn cached_size(&self) -> u32

Get size previously computed by compute_size.

Note if message size exceeds u32, the cached size is stored truncated.

fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<()>

Write the message to the stream.

Results in error if message is not fully initialized.

fn write_length_delimited_to( &self, os: &mut CodedOutputStream<'_>, ) -> Result<()>

Write the message to the stream prepending the message with message length encoded as varint.

fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<()>

Write the message to the vec, prepend the message with message length encoded as varint.

fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<()>

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> Result<Self>

Parse message from reader. Parse stops on EOF or when error encountered.

fn parse_from_bytes(bytes: &[u8]) -> Result<Self>

Parse message from byte array.

fn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self>

Parse message from Bytes object. Resulting message may share references to the passed bytes object.

fn check_initialized(&self) -> Result<()>

Check if all required fields of this object are initialized.

fn write_to_writer(&self, w: &mut dyn Write) -> Result<()>

Write the message to the writer.

fn write_to_vec(&self, v: &mut Vec<u8>) -> Result<()>

Write the message to bytes vec.

fn write_to_bytes(&self) -> Result<Vec<u8>>

Write the message to bytes vec.

Note: You can use Message::parse_from_bytes to do the reverse.

fn write_length_delimited_to_writer(&self, w: &mut dyn Write) -> Result<()>

Write the message to the writer, prepend the message with message length encoded as varint.

fn write_length_delimited_to_bytes(&self) -> Result<Vec<u8>>

Write the message to the bytes vec, prepend the message with message length encoded as varint.

fn unknown_fields(&self) -> &UnknownFields

Get a reference to unknown fields.

fn mut_unknown_fields(&mut self) -> &mut UnknownFields

Get a mutable reference to unknown fields.

fn clear(&mut self)

Reset all fields.

Object Safety

This trait is not object safe.

Implementors

impl Message for ExtensionRange

const NAME: &'static str = "ExtensionRange"

impl Message for ReservedRange

const NAME: &'static str = "ReservedRange"

impl Message for EnumReservedRange

const NAME: &'static str = "EnumReservedRange"

impl Message for Annotation

const NAME: &'static str = "Annotation"

impl Message for Location

const NAME: &'static str = "Location"

impl Message for DescriptorProto

const NAME: &'static str = "DescriptorProto"

impl Message for EnumDescriptorProto

const NAME: &'static str = "EnumDescriptorProto"

impl Message for EnumOptions

const NAME: &'static str = "EnumOptions"

impl Message for EnumValueDescriptorProto

const NAME: &'static str = "EnumValueDescriptorProto"

impl Message for EnumValueOptions

const NAME: &'static str = "EnumValueOptions"

impl Message for ExtensionRangeOptions

const NAME: &'static str = "ExtensionRangeOptions"

impl Message for FieldDescriptorProto

const NAME: &'static str = "FieldDescriptorProto"

impl Message for FieldOptions

const NAME: &'static str = "FieldOptions"

impl Message for FileDescriptorProto

const NAME: &'static str = "FileDescriptorProto"

impl Message for FileDescriptorSet

const NAME: &'static str = "FileDescriptorSet"

impl Message for FileOptions

const NAME: &'static str = "FileOptions"

impl Message for GeneratedCodeInfo

const NAME: &'static str = "GeneratedCodeInfo"

impl Message for MessageOptions

const NAME: &'static str = "MessageOptions"

impl Message for MethodDescriptorProto

const NAME: &'static str = "MethodDescriptorProto"

impl Message for MethodOptions

const NAME: &'static str = "MethodOptions"

impl Message for OneofDescriptorProto

const NAME: &'static str = "OneofDescriptorProto"

impl Message for OneofOptions

const NAME: &'static str = "OneofOptions"

impl Message for ServiceDescriptorProto

const NAME: &'static str = "ServiceDescriptorProto"

impl Message for ServiceOptions

const NAME: &'static str = "ServiceOptions"

impl Message for SourceCodeInfo

const NAME: &'static str = "SourceCodeInfo"

impl Message for UninterpretedOption

const NAME: &'static str = "UninterpretedOption"

impl Message for NamePart

const NAME: &'static str = "NamePart"

impl Message for File

const NAME: &'static str = "File"

impl Message for CodeGeneratorRequest

const NAME: &'static str = "CodeGeneratorRequest"

impl Message for CodeGeneratorResponse

const NAME: &'static str = "CodeGeneratorResponse"

impl Message for Version

const NAME: &'static str = "Version"

impl Message for Any

const NAME: &'static str = "Any"

impl Message for Api

const NAME: &'static str = "Api"

impl Message for Method

const NAME: &'static str = "Method"

impl Message for Mixin

const NAME: &'static str = "Mixin"

impl Message for Duration

const NAME: &'static str = "Duration"

impl Message for Empty

const NAME: &'static str = "Empty"

impl Message for FieldMask

const NAME: &'static str = "FieldMask"

impl Message for SourceContext

const NAME: &'static str = "SourceContext"

impl Message for ListValue

const NAME: &'static str = "ListValue"

impl Message for Struct

const NAME: &'static str = "Struct"

impl Message for Value

const NAME: &'static str = "Value"

impl Message for Timestamp

const NAME: &'static str = "Timestamp"

impl Message for Enum

const NAME: &'static str = "Enum"

impl Message for EnumValue

const NAME: &'static str = "EnumValue"

impl Message for Field

const NAME: &'static str = "Field"

impl Message for Option

const NAME: &'static str = "Option"

impl Message for Type

const NAME: &'static str = "Type"

impl Message for BoolValue

const NAME: &'static str = "BoolValue"

impl Message for BytesValue

const NAME: &'static str = "BytesValue"

impl Message for DoubleValue

const NAME: &'static str = "DoubleValue"

impl Message for FloatValue

const NAME: &'static str = "FloatValue"

impl Message for Int32Value

const NAME: &'static str = "Int32Value"

impl Message for Int64Value

const NAME: &'static str = "Int64Value"

impl Message for StringValue

const NAME: &'static str = "StringValue"

impl Message for UInt32Value

const NAME: &'static str = "UInt32Value"

impl Message for UInt64Value

const NAME: &'static str = "UInt64Value"