Struct Field

#[non_exhaustive]
#[repr(C)]
pub struct Field {
    pub name: &'static str,
    pub shape: fn() -> &'static Shape,
    pub offset: usize,
    pub flags: FieldFlags,
    pub attributes: &'static [FieldAttribute],
    pub doc: &'static [&'static str],
    pub vtable: &'static FieldVTable,
    pub flattened: bool,
}

Describes a field in a struct or tuple

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: &'static str

key for the struct field (for tuples and tuple-structs, this is the 0-based index)

shape: fn() -> &'static Shape

shape of the inner type

offset: usize

offset of the field in the struct (obtained through core::mem::offset_of)

flags: FieldFlags

flags for the field (e.g. sensitive, etc.)

attributes: &'static [FieldAttribute]

arbitrary attributes set via the derive macro

doc: &'static [&'static str]

doc comments

vtable: &'static FieldVTable

vtable for fields

flattened: bool

true if returned from fields_for_serialize and it was flattened - which means, if it’s an enum, the outer variant shouldn’t be written.

Implementations

impl Field

pub unsafe fn should_skip_serializing(&self, ptr: PtrConst<'_>) -> bool

Returns true if the field has the skip-serializing unconditionally flag or if it has the skip-serializing-if function in its vtable and it returns true on the given data.

Safety

The peek should correspond to a value of the same type as this field

impl Field

pub fn shape(&self) -> &'static Shape

Returns the shape of the inner type

pub const fn builder() -> FieldBuilder

Returns a builder for Field

pub fn is_sensitive(&'static self) -> bool

Checks if field is marked as sensitive through attributes or flags

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

impl Eq for Field

impl StructuralPartialEq for Field