Struct Enumeration 

pub struct Enumeration {
    pub name: String,
    pub mappings: BTreeMap<String, String>,
    pub docstring: String,
    pub position: Option<Position>,
}

Represents an enumeration with a name and mappings.

Fields

name: String

Name of the enumeration.

mappings: BTreeMap<String, String>

Mappings associated with the enumeration.

docstring: String

Documentation string for the enumeration.

position: Option<Position>

The line number of the enumeration

Implementations

impl Enumeration

pub fn has_values(&self) -> bool

Checks if the enumeration has any values.

Returns

• bool - true if the enumeration has values, false otherwise.

pub fn set_position(&mut self, position: Position)

Sets the position of the enumeration.

Arguments

• position - The position to set.

Trait Implementations

impl Clone for Enumeration

fn clone(&self) -> Enumeration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Enumeration

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

Formats the value using the given formatter.

impl Default for Enumeration

fn default() -> Enumeration

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Enumeration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<EnumDefinition> for Enumeration

Implements conversion from LinkML EnumDefinition to Enumeration.

fn from(enum_def: EnumDefinition) -> Self

Converts a LinkML EnumDefinition into an internal Enumeration representation.

This conversion preserves:

• Documentation
• Enumeration values and their meanings
• Value mappings

Arguments

• enum_def - The LinkML EnumDefinition to convert

Returns

An Enumeration representing the enum in the internal model format

impl From<Enumeration> for EnumDefinition

Implements conversion from Enumeration to LinkML EnumDefinition.

fn from(enum_: Enumeration) -> Self

Converts an Enumeration into a LinkML EnumDefinition.

This conversion process handles:

• Documentation preservation
• Enumeration values and their meanings
• Value descriptions
• Semantic mappings

impl Hash for Enumeration

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 Enumeration

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Enumeration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Enumeration> for EnumObject

fn try_from(enumeration: &Enumeration) -> Result<Self, Self::Error>

Attempts to convert an Enumeration into an EnumObject.

Arguments

• enumeration - A reference to the Enumeration.

Returns

A Result containing the EnumObject or an error message.

type Error = String

The type returned in the event of a conversion error.

impl TryFrom<&Enumeration> for SchemaType

fn try_from(enumeration: &Enumeration) -> Result<Self, Self::Error>

Attempts to convert an Enumeration into a SchemaType.

Arguments

• enumeration - A reference to the Enumeration.

Returns

A Result containing the SchemaType or an error message.

type Error = String

The type returned in the event of a conversion error.

impl TryFrom<EnumObject> for Enumeration

Converts a JSON Schema enum object to an Enumeration

This implementation handles the conversion of enum values to mappings, escaping invalid keys as needed.

type Error = Box<dyn Error>

The type returned in the event of a conversion error.

fn try_from(enum_obj: EnumObject) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Enumeration