Enum KnowledgeSlot 

#[non_exhaustive]
pub enum KnowledgeSlot {
    TableDescription,
    TableAlias,
    TableGrain,
    TableDefaultTime,
    ColumnDescription {
        column: String,
    },
    ColumnRole {
        column: String,
    },
}

The position a piece of knowledge occupies on a database object.

Column-scoped variants carry the column name, so column:created_at.role and column:updated_at.role are different single-valued slots. The string form (as_str) is the stable identifier that is compared, stored and rendered; it round-trips through parse. Serialisation uses that same string form, so a stored slot is its canonical identifier.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

TableDescription

TableAlias

TableGrain

TableDefaultTime

ColumnDescription

Fields

column: String

ColumnRole

Fields

column: String

Implementations

impl KnowledgeSlot

pub fn as_str(&self) -> String

The canonical string form. Returns an owned String (not &'static str like the fieldless contract enums) because the column-scoped variants carry a column name; the sibling carrying type DatabaseObjectRef::qualified_name returns String for the same reason.

pub fn parse(value: &str) -> Option<Self>

Inverse of as_str. Returns None for an unknown or malformed slot rather than panicking. A column name that fails validate_name (empty, too long, control characters) is not a slot, so it too yields None. Parsing strips a fixed suffix (.description / .role), not a split on ., so a column name containing dots is unambiguous.

pub const fn cardinality(&self) -> SlotCardinality

How many values this slot admits, declared on the slot so any holder can ask without consulting a table elsewhere. Single-valued slots admit one; multi-valued slots admit MAX_MULTI_SLOT_VALUES.

pub fn column(&self) -> Option<&str>

The column this slot is scoped to, or None for a table-level slot.

Trait Implementations

impl Clone for KnowledgeSlot

fn clone(&self) -> KnowledgeSlot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KnowledgeSlot

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KnowledgeSlot

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for KnowledgeSlot

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

Formats the value using the given formatter.

impl Eq for KnowledgeSlot

impl From<KnowledgeSlot> for String

fn from(slot: KnowledgeSlot) -> String

Converts to this type from the input type.

impl Hash for KnowledgeSlot

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 KnowledgeSlot

fn eq(&self, other: &KnowledgeSlot) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for KnowledgeSlot

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KnowledgeSlot

impl TryFrom<String> for KnowledgeSlot

type Error = SlotParseError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.