Struct FieldInfo

#[non_exhaustive]
pub struct FieldInfo {
    pub format: Format,
    pub referenced_types: Vec<TypeReference>,
}

Rich semantic information of an API field beyond basic typing.

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.

format: Format

The standard format of a field value. This does not explicitly configure any API consumer, just documents the API’s format for the field it is applied to.

referenced_types: Vec<TypeReference>

The type(s) that the annotated, generic field may represent.

Currently, this must only be used on fields of type google.protobuf.Any. Supporting other generic types may be considered in the future.

Implementations

impl FieldInfo

pub fn set_format<T: Into<Format>>(self, v: T) -> Self

Sets the value of format.

pub fn set_referenced_types<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<TypeReference>,

Sets the value of referenced_types.

Trait Implementations

impl Clone for FieldInfo

fn clone(&self) -> FieldInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldInfo

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

Formats the value using the given formatter.

impl Default for FieldInfo

fn default() -> FieldInfo

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FieldInfo

where FieldInfo: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for FieldInfo

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FieldInfo

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

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 FieldInfo