Struct ProtocolConfig 

#[non_exhaustive]
pub struct ProtocolConfig {
    pub protocol_version: Option<u64>,
    pub feature_flags: Option<ProtocolFeatureFlags>,
    pub attributes: Option<ProtocolAttributes>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

protocol_version: Option<u64>

feature_flags: Option<ProtocolFeatureFlags>

attributes: Option<ProtocolAttributes>

Implementations

impl ProtocolConfig

pub const PROTOCOL_VERSION_FIELD: &'static MessageField

pub const FEATURE_FLAGS_FIELD: &'static MessageField

pub const ATTRIBUTES_FIELD: &'static MessageField

impl ProtocolConfig

pub fn path_builder() -> ProtocolConfigFieldPathBuilder

impl ProtocolConfig

pub fn with_protocol_version(self, field: u64) -> Self

Sets protocol_version with the provided value.

pub fn with_feature_flags<T: Into<ProtocolFeatureFlags>>(self, field: T) -> Self

Sets feature_flags with the provided value.

pub fn with_attributes<T: Into<ProtocolAttributes>>(self, field: T) -> Self

Sets attributes with the provided value.

impl ProtocolConfig

pub fn protocol_version(&self) -> u64

Returns the value of protocol_version, or the default value if protocol_version is unset.

impl ProtocolConfig

pub fn version(&self) -> Result<ProtocolVersion, TryFromProtoError>

Get the protocol version number.

Requires protocol_version in the read_mask.

pub fn feature_flags( &self, ) -> Result<&BTreeMap<String, bool>, TryFromProtoError>

Get the feature flags map.

Requires feature_flags in the read_mask to return all flags. Use feature_flags.{name} to request only specific named flags.

pub fn attributes(&self) -> Result<&BTreeMap<String, String>, TryFromProtoError>

Get the protocol attributes map.

Requires attributes in the read_mask to return all attributes. Use attributes.{name} to request only specific named attributes.

Trait Implementations

impl Clone for ProtocolConfig

fn clone(&self) -> ProtocolConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProtocolConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for ProtocolConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for ProtocolConfig

const FIELDS: &'static [&'static MessageField]

const ONEOFS: &'static [&'static str] = _

Oneof group names declared in this message.

impl PartialEq for ProtocolConfig

fn eq(&self, other: &ProtocolConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ProtocolConfig