Skip to main content

AttrOption

Enum AttrOption 

Source
pub enum AttrOption {
Show 16 variants Example(String), MinimumValue(f64), MaximumValue(f64), MinItems(usize), MaxItems(usize), MinLength(usize), MaxLength(usize), Pattern(String), Unique(bool), MultipleOf(i32), ExclusiveMinimum(f64), ExclusiveMaximum(f64), PrimaryKey(bool), ReadOnly(bool), Recommended(bool), Other { key: String, value: String, },
}
Expand description

Represents an option for an attribute in a data model.

This enum provides a strongly-typed representation of various attribute options that can be used to configure and constrain attributes in a data model.

The options are grouped into several categories:

  • JSON Schema validation options (e.g., minimum/maximum values, length constraints)
  • SQL database options (e.g., primary key)
  • LinkML specific options (e.g., readonly, recommended)
  • Custom options via the Other variant

Variants§

§

Example(String)

§

MinimumValue(f64)

Specifies the minimum value for a numeric attribute

§

MaximumValue(f64)

Specifies the maximum value for a numeric attribute

§

MinItems(usize)

Specifies the minimum number of items for an array attribute

§

MaxItems(usize)

Specifies the maximum number of items for an array attribute

§

MinLength(usize)

Specifies the minimum length for a string attribute

§

MaxLength(usize)

Specifies the maximum length for a string attribute

§

Pattern(String)

Specifies a regular expression pattern that a string attribute must match

§

Unique(bool)

Specifies whether array items must be unique

§

MultipleOf(i32)

Specifies that a numeric value must be a multiple of this number

§

ExclusiveMinimum(f64)

Specifies an exclusive minimum value for a numeric attribute

§

ExclusiveMaximum(f64)

Specifies an exclusive maximum value for a numeric attribute

§

PrimaryKey(bool)

Indicates whether the attribute is a primary key in a database

§

ReadOnly(bool)

Indicates whether the attribute is read-only

§

Recommended(bool)

Indicates whether the attribute is recommended to be included

§

Other

Represents a custom option not covered by the predefined variants

Fields

§key: String

The key/name of the custom option

§value: String

The value of the custom option

Implementations§

Source§

impl AttrOption

Source

pub fn from_pair(key: &str, value: &str) -> Result<Self, Box<dyn Error>>

Creates a new AttrOption from a key-value pair.

This method attempts to parse the key and value into an appropriate AttrOption variant. If the key matches a known option type, it will attempt to parse the value into the appropriate type. If the key is not recognized, it will create an Other variant.

§Arguments
  • key - The string key identifying the option type
  • value - The string value to be parsed into the appropriate type
§Returns

A Result containing either the parsed AttrOption or an error if parsing fails

Source

pub fn to_pair(&self) -> (String, String)

Converts the option into a key-value pair.

§Returns

A tuple containing the option’s key and value as strings

Source

pub fn key(&self) -> String

Gets the key/name of the option.

For predefined options, this returns the serialized name. For custom options, this returns the custom key.

§Returns

The option’s key as a String

Source

pub fn value(&self) -> String

Gets the value of the option as a string.

§Returns

The option’s value converted to a String

Trait Implementations§

Source§

impl Clone for AttrOption

Source§

fn clone(&self) -> AttrOption

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AttrOption

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for AttrOption

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for AttrOption

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<AttrOption> for RawOption

Source§

fn from(option: AttrOption) -> Self

Converts to this type from the input type.
Source§

impl FromStr for AttrOption

Source§

type Err = ParseError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<AttrOption, <Self as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for AttrOption

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for AttrOption

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<&AttrOption> for PrimitiveType

Source§

type Error = String

The type returned in the event of a conversion error.
Source§

fn try_from(option: &AttrOption) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<&str> for AttrOption

Source§

type Error = ParseError

The type returned in the event of a conversion error.
Source§

fn try_from(s: &str) -> Result<AttrOption, <Self as TryFrom<&str>>::Error>

Performs the conversion.
Source§

impl TryFrom<RawOption> for AttrOption

Source§

type Error = Box<dyn Error>

The type returned in the event of a conversion error.
Source§

fn try_from(option: RawOption) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl StructuralPartialEq for AttrOption

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,