Struct RelationConfig 

#[non_exhaustive]
pub struct RelationConfig {
    pub name: String,
    pub title: Text,
    pub label: Text,
    pub entity: String,
    pub foreign_key: Option<String>,
    pub pivot: Option<PivotConfig>,
    pub list: ListConfig,
    pub form: FormConfig,
    pub permission: Option<String>,
}

One relation a resource declares, listed and edited on the parent’s edit page: rows of entity whose foreign_key holds the parent’s id (has-many), or rows of entity a pivot table joins to the parent (many-to-many).

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: String

The relation’s name: the key in a descriptor, the path segment under the parent (/products/7/variants). Not new, edit, delete, import, export or columns, which the parent’s own routes use.

title: Text

The section heading, plural (Variants). Defaults to the name, humanized.

label: Text

One related record, singular (Variant), for the New or Attach button and the child form’s title.

entity: String

The related table.

foreign_key: Option<String>

Has-many: the column on the related table holding the parent’s id.

pivot: Option<PivotConfig>

Many-to-many: the table joining the parent to the related table.

list: ListConfig

The section’s list over the related table.

form: FormConfig

Has-many: the related record’s form; the foreign key is written by the framework, and a field of that name here is kept hidden. Many-to-many: the fields kept on the pivot row, asked for on Attach and editable from the section; none means a membership carries nothing of its own.

permission: Option<String>

A permission the operator must hold for the section and its pages, besides the parent’s. None asks for the parent’s alone.

Implementations

impl RelationConfig

pub fn has_many( name: impl Into<String>, label: impl Into<Text>, entity: impl Into<String>, foreign_key: impl Into<String>, list: ListConfig, form: FormConfig, ) -> Self

A has-many relation: rows of entity whose foreign_key names the parent, listed by list and edited through form.

pub fn belongs_to_many( name: impl Into<String>, label: impl Into<Text>, entity: impl Into<String>, pivot: PivotConfig, list: ListConfig, ) -> Self

A many-to-many relation: rows of entity that pivot joins to the parent, listed by list. Fields kept on the pivot row go on form.

pub fn form(self, form: FormConfig) -> Self

The fields kept on a many-to-many relation’s pivot row.

pub fn title(self, title: impl Into<Text>) -> Self

The section heading.

pub fn permission(self, code: impl Into<String>) -> Self

A permission the operator must also hold.

Trait Implementations

impl Clone for RelationConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelationConfig

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

Formats the value using the given formatter.

impl Default for RelationConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RelationConfig

where RelationConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RelationConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.