Struct FieldView 

pub struct FieldView<'view, 'a, P> { /* private fields */ }

A graph-aware view of a struct or union field.

Implementations

impl<'view, 'graph, 'a: 'graph, P: ViewNode<'graph, 'a>> FieldView<'view, 'a, P>

pub fn name(&self) -> StructFieldName<'a>

Returns the field name.

pub fn ty(&self) -> TypeView<'graph, 'a>

Returns a view of the inner type that this type wraps.

pub fn required(&self) -> Required

Returns whether this field is required or optional.

pub fn description(&self) -> Option<&'a str>

Returns the description, if present in the schema.

pub fn flattened(&self) -> bool

Returns true if this field is flattened from an anyOf parent.

impl<'view, 'graph, 'a> FieldView<'view, 'a, StructView<'graph, 'a>>

pub fn inherited(&self) -> bool

Returns true if this field was inherited from a parent via allOf.

pub fn tag(&self) -> bool

Returns true if this field is a tag.

A field is a tag only if this struct inherits from or is a variant of a tagged union, and the field name matches that union’s tag.

pub fn needs_box(&self) -> bool

Returns true if this field needs Box<T> to break a cycle.

A field needs boxing if its target type is in the same strongly connected component as the type that contains it, excluding edges through heap-allocating containers (arrays and maps).

Trait Implementations

impl<'view, 'a, P: Debug> Debug for FieldView<'view, 'a, P>

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

Formats the value using the given formatter.