Struct FieldType

pub struct FieldType<'a> { /* private fields */ }

The description of a field type.

Implementations

impl<'a> FieldType<'a>

pub const fn repeated(self) -> FieldType<'a>

Returns a repeated version of this field type.

Panics if the field type is already a sequence type.

pub const fn optional(self) -> FieldType<'a>

Returns a optional version of this field type.

Panics if the field type is already a sequence type.

pub const fn annotate(self, annotation: &'a str) -> FieldType<'a>

Sets an annotation to show up in the .proto file.

pub const fn map(kv: &'a [FieldType<'a>; 2]) -> FieldType<'a>

Returns a map type.

If key is not a builtin numeric scalar or string type, or if value is an optional or repeated type, then this will result in a repeated tuple instead of a protobuf map type. The encodings for these are the same, but .proto map types are constrained to mappings from scalars to non-optional/repeated scalars and messages.

pub const fn message(f: fn() -> MessageDescription<'a>) -> FieldType<'a>

Returns a field type for a message whose top-level descriptor is returned by f.

This is abstracted through a function to allow for recursive types. Currently Rust does not allow a const to refer to a static, but it does allow a const to refer to a function that returns a &'static.

pub const fn local(name: &'a str) -> FieldType<'a>

Returns a field type for a local message type with name.

pub const fn builtin(name: &'a str) -> FieldType<'a>

Returns a field type for a builtin type, such as uint32.

pub const fn tuple(field_types: &'a [FieldType<'a>]) -> FieldType<'a>

Returns a field type for an anonymous tuple.

pub const fn external(name: &'a str, import_path: &'static str) -> FieldType<'a>

Returns a field type for an external type with the given fully-qualified name and protoc import path.

pub const fn is_sequence(&self) -> bool

Returns true if this is a sequence type (optional or repeated).

pub const fn can_pack(&self) -> bool

Returns true if this type can use a packed encoding in a repeated context.

Trait Implementations

impl<'a> Clone for FieldType<'a>

fn clone(&self) -> FieldType<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for FieldType<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for FieldType<'a>

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

where __H: Hasher,

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<'a> PartialEq for FieldType<'a>

fn eq(&self, other: &FieldType<'a>) -> 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<'a> Copy for FieldType<'a>

impl<'a> Eq for FieldType<'a>

impl<'a> StructuralPartialEq for FieldType<'a>