Struct ReferenceSpec 

#[non_exhaustive]
pub struct ReferenceSpec<R = NoExtras> {
    pub table: String,
    pub kind: ReferenceKind,
    pub foreign_key: Option<String>,
    pub keys: Vec<JoinKey>,
    pub driver: R,
}

Top-level reference declaration in a VistaSpec.

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.

table: String

kind: ReferenceKind

has_one or has_many; defaults to has_one.

foreign_key: Option<String>

keys: Vec<JoinKey>

Extra join keys for row-supplied traversal. When non-empty these fully describe the join: each maps a parent (locked-row) column to a child column, and the child is constrained by all of them. This lets a child be narrowed by more than one parent field (e.g. a deployment narrowed by both product_id and version_id). When empty, the single foreign_key sugar applies.

driver: R

Implementations

impl<R> ReferenceSpec<R>

pub fn foreign_key(&self, relation: &str) -> String

The foreign_key: column, else relation, the name the reference is declared under.

pub fn to_reference(&self, relation: &str, source_id: &str) -> Result<Reference>

The join this entry declares under relation. Its keys: when given (each pair reads a parent-row column and constrains a target column), else the single foreign_key: on the parent for has_one (matched to the target’s id), on the target for has_many (matched to the parent’s source_id). A contained kind is refused: contained relations are declared under contained:.

Trait Implementations

impl<R: Clone> Clone for ReferenceSpec<R>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for ReferenceSpec<R>

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

Formats the value using the given formatter.

impl<'de, R> Deserialize<'de> for ReferenceSpec<R>

where R: DeserializeOwned + Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<R> Serialize for ReferenceSpec<R>

where R: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.