Struct FieldNumber 

pub struct FieldNumber(/* private fields */);

A validated Protocol Buffers field number.

Field numbers must be in the range [1, 2^29 - 1].

Implementations

impl FieldNumber

pub const MIN: Self

Minimum allowed field number (1).

pub const MAX: Self

Maximum allowed field number (2^29 - 1 = 536,870,911).

pub const MAX_SINGLE_BYTE_TAG: u32 = 15u32

Maximum field number that can be encoded as a single-byte tag (15). Field numbers 1-15 result in tags that fit in 1 byte.

pub const RESERVED_RANGE_START: u32 = 19_000u32

Start of reserved field number range (19000). Protobuf reserves field numbers 19000-19999.

pub const RESERVED_RANGE_END: u32 = 19_999u32

End of reserved field number range (19999). Protobuf reserves field numbers 19000-19999.

pub fn try_new(value: u32) -> Result<Self, ProtobufError>

Creates a new field number, validating the range.

pub fn is_tag_single_byte(&self) -> bool

Checks if the field number can be encoded as a single-byte tag. Field numbers 1-15 result in tags that fit in 1 byte.

pub fn is_reserved(&self) -> bool

Checks if the field number is in a reserved range. Protobuf reserves field numbers 19000-19999, inclusive.

pub fn is_in_range(&self, min: u32, max: u32) -> bool

Checks if the field number is in a specific range, inclusive.

pub fn encoded_size(&self) -> usize

Returns the minimum number of bytes needed to encode the tag (field_number + wire_type) as a varint.

The tag is encoded as: (field_number << 3) | wire_type Since wire_type is 0-7, the maximum tag value is (field_number * 8) + 7

pub fn as_u32(&self) -> u32

Returns the field number as a u32.

pub fn as_i32(&self) -> i32

Returns the filed number as a i32

pub fn as_usize(&self) -> usize

Returns the field number as a usize.

Trait Implementations

impl Clone for FieldNumber

fn clone(&self) -> FieldNumber

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldNumber

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

Formats the value using the given formatter.

impl From<FieldNumber> for i32

fn from(field_number: FieldNumber) -> Self

Converts to this type from the input type.

impl From<FieldNumber> for u32

fn from(field_number: FieldNumber) -> Self

Converts to this type from the input type.

impl From<FieldNumber> for usize

fn from(field_number: FieldNumber) -> Self

Converts to this type from the input type.

impl Hash for FieldNumber

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FieldNumber

fn cmp(&self, other: &FieldNumber) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FieldNumber

fn eq(&self, other: &FieldNumber) -> 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 PartialOrd for FieldNumber

fn partial_cmp(&self, other: &FieldNumber) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for FieldNumber

type Error = ProtobufError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for FieldNumber

type Error = ProtobufError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for FieldNumber

impl Eq for FieldNumber

impl StructuralPartialEq for FieldNumber