Struct fdb_rl::key_expression::pb::ProtoFieldV1

pub(crate) struct ProtoFieldV1 {
    pub field_number: Option<u32>,
    pub field_label: Option<FieldLabel>,
}

Protobuf generated types renamed to prepend Proto and append version. Protobuf message field is specified here [1].

Java RecordLayer uses field name. In protobuf, field names are not serialized on the wire and can be renamed. While this is more ergonomical, it is also brittle, especially when the semantics of the name changes and is assigned to a new tag number.

In our case we use field number and that maps directly to the “tag” in the binary format. .

[1]: https://protobuf.com/docs/language-spec#fields

Fields

field_number: Option<u32>

Required.

Labeling this as optional, so that in Rust we get a Option<u32> type, and we do not accidentally set it to 0.

field_label: Option<FieldLabel>

Required.

Implementations

impl Field

pub fn field_number(&self) -> u32

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

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl Default for Field

fn default() -> Field

Returns the “default value” for a type.

impl From<FieldInternalV1> for Field

fn from(field_internal_v1: FieldInternalV1) -> ProtoFieldV1

Converts to this type from the input type.

impl Message for Field

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

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

fn decode<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

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

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

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

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

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

impl PartialEq<Field> for Field

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl ReflectMessage for Field

fn descriptor(&self) -> MessageDescriptor

Gets a MessageDescriptor describing the type of this message.

fn transcode_to_dynamic(&self) -> DynamicMessagewhere Self: Sized,

Converts this message into an instance of DynamicMessage by going through the byte representation.

impl TryFrom<Field> for FieldInternalV1

type Error = FdbError

The type returned in the event of a conversion error.

fn try_from(proto_field_v1: ProtoFieldV1) -> FdbResult<FieldInternalV1>

Performs the conversion.

impl StructuralPartialEq for Field