Struct FieldDescriptor

#[non_exhaustive]
pub struct FieldDescriptor {
    pub name: Option<String>,
    pub position: Option<u32>,
    pub type: Option<OpenSignatureBody>,
}

Descriptor of a field that belongs to a struct or enum variant

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.

name: Option<String>

Name of the field

position: Option<u32>

Order or position of the field in the struct or enum variant definition.

type: Option<OpenSignatureBody>

The type of the field

Implementations

impl FieldDescriptor

pub const NAME_FIELD: &'static MessageField

pub const POSITION_FIELD: &'static MessageField

pub const TYPE_FIELD: &'static MessageField

impl FieldDescriptor

pub fn path_builder() -> FieldDescriptorFieldPathBuilder

impl FieldDescriptor

pub const fn const_default() -> Self

pub fn name_opt_mut(&mut self) -> Option<&mut String>

If name is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn name_mut(&mut self) -> &mut String

Returns a mutable reference to name. If the field is unset, it is first initialized with the default value.

pub fn name_opt(&self) -> Option<&str>

If name is set, returns Some with the value; otherwise returns None.

pub fn set_name<T: Into<String>>(&mut self, field: T)

Sets name with the provided value.

pub fn with_name<T: Into<String>>(self, field: T) -> Self

Sets name with the provided value.

pub fn position_opt_mut(&mut self) -> Option<&mut u32>

If position is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn position_mut(&mut self) -> &mut u32

Returns a mutable reference to position. If the field is unset, it is first initialized with the default value.

pub fn position_opt(&self) -> Option<u32>

If position is set, returns Some with the value; otherwise returns None.

pub fn set_position<T: Into<u32>>(&mut self, field: T)

Sets position with the provided value.

pub fn with_position<T: Into<u32>>(self, field: T) -> Self

Sets position with the provided value.

pub fn type(&self) -> &OpenSignatureBody

Returns the value of r#type, or the default value if r#type is unset.

pub fn type_opt_mut(&mut self) -> Option<&mut OpenSignatureBody>

If r#type is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn type_mut(&mut self) -> &mut OpenSignatureBody

Returns a mutable reference to r#type. If the field is unset, it is first initialized with the default value.

pub fn type_opt(&self) -> Option<&OpenSignatureBody>

If r#type is set, returns Some with the value; otherwise returns None.

pub fn set_type<T: Into<OpenSignatureBody>>(&mut self, field: T)

Sets r#type with the provided value.

pub fn with_type<T: Into<OpenSignatureBody>>(self, field: T) -> Self

Sets r#type with the provided value.

impl FieldDescriptor

pub fn name(&self) -> &str

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

pub fn position(&self) -> u32

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

Trait Implementations

impl Clone for FieldDescriptor

fn clone(&self) -> FieldDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldDescriptor

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

Formats the value using the given formatter.

impl Default for FieldDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FieldDescriptor

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for FieldDescriptor

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 FieldDescriptor

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

impl PartialEq for FieldDescriptor

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FieldDescriptor