Struct Field

pub struct Field {
    pub name: String,
    pub serde_name: String,
    pub description: String,
    pub deprecation_note: Option<String>,
    pub type_ref: TypeReference,
    pub required: bool,
    pub flattened: bool,
    pub transform_callback: String,
    pub transform_callback_fn: Option<fn(&mut TypeReference, &Typespace)>,
}

Fields

name: String

Field name, should be a valid Rust field name identifier

serde_name: String

If a serialized name is not a valid Rust field name identifier then this defines the name of a field to be used in serialization

description: String

Rust docs for the field

deprecation_note: Option<String>

Deprecation note. If none, field is not deprecated. If present as empty string, field is deprecated without a note.

type_ref: TypeReference

Type of a field

required: bool

required and not nullable:

• field always present and not null / none

required and nullable:

• Rust: Option, do not skip serializing if None
• TypeScript: T | null, do not skip serializing if null

not required and not nullable:

• Rust: Option, skip serializing if None
• TypeScript: T | undefined, skip serializing if undefined

not required and nullable: serializers and deserializers are required to differentiate between missing fields and null / none fields

• Rust: reflectapi::Option is enum with Undefined, None and Some variants
• TypeScript: T | null | undefined

Default is false

flattened: bool

If serde flatten attribute is set on a field Default is false

transform_callback: String

transform_callback_fn: Option<fn(&mut TypeReference, &Typespace)>

Implementations

impl Field

pub fn new(name: String, type_ref: TypeReference) -> Self

pub fn with_required(self, required: bool) -> Self

pub fn name(&self) -> &str

pub fn is_named(&self) -> bool

pub fn is_unnamed(&self) -> bool

pub fn serde_name(&self) -> &str

pub fn description(&self) -> &str

pub fn deprecated(&self) -> bool

pub fn type_ref(&self) -> &TypeReference

pub fn required(&self) -> bool

pub fn flattened(&self) -> bool

pub fn transform_callback(&self) -> &str

pub fn transform_callback_fn( &self, ) -> Option<fn(&mut TypeReference, &Typespace)>

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Field

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Field

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 PartialEq for Field

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl VisitMut for Field

fn visit_mut<V: Visitor>( &mut self, visitor: &mut V, ) -> ControlFlow<V::Output, V::Output>

impl Eq for Field

impl StructuralPartialEq for Field