Struct TemplateRefField 

pub struct TemplateRefField {
    pub idx: u8,
    pub name: String,
    pub bind: Option<TemplateRefFieldBind>,
    pub fields: Option<Vec<TemplateRefField>>,
}

Declaration for which fields from a content definition or data model to include.

Fields

idx: u8

Specifies index for reference field. Index must be unique across fields for a given reference.

name: String

Name of field to be included.

bind: Option<TemplateRefFieldBind>

Option to bind this field’s value to a route segment, querystring parameter or token field.

IMPORTANT: this property is being deprecated. Switch to using the TemplateRef::predicate config field, instead.

fields: Option<Vec<TemplateRefField>>

List of any nested subfields to include for this field.

Trait Implementations

impl Clone for TemplateRefField

fn clone(&self) -> TemplateRefField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for TemplateRefField

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for TemplateRefField

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

Formats the value using the given formatter.

impl Default for TemplateRefField

fn default() -> TemplateRefField

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TemplateRefField

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for TemplateRefField

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for TemplateRefField

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for TemplateRefField

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.