Struct mesh_protobuf::protofile::FieldType

source ·
pub struct FieldType<'a> { /* private fields */ }
Expand description

The description of a field type.

Implementations§

source§

impl<'a> FieldType<'a>

source

pub const fn repeated(self) -> Self

Returns a repeated version of this field type.

Panics if the field type is already a sequence type.

source

pub const fn optional(self) -> Self

Returns a optional version of this field type.

Panics if the field type is already a sequence type.

source

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

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

source

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

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.

source

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

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.

source

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

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

source

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

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

source

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

Returns a field type for an anonymous tuple.

source

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

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

source

pub const fn is_sequence(&self) -> bool

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

source

pub const fn can_pack(&self) -> bool

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

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'a> PartialEq for FieldType<'a>

source§

fn eq(&self, other: &FieldType<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl<'a> Copy for FieldType<'a>

source§

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

source§

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

Auto Trait Implementations§

§

impl<'a> Freeze for FieldType<'a>

§

impl<'a> RefUnwindSafe for FieldType<'a>

§

impl<'a> Send for FieldType<'a>

§

impl<'a> Sync for FieldType<'a>

§

impl<'a> Unpin for FieldType<'a>

§

impl<'a> UnwindSafe for FieldType<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T, U> Upcast<U> for T
where U: Downcast<T>,