Skip to main content

Object

Struct Object 

Source
pub struct Object {
    pub name: String,
    pub attributes: Vec<Attribute>,
    pub docstring: String,
    pub term: Option<String>,
    pub mixins: Vec<String>,
    pub position: Option<Position>,
}
Expand description

Represents an object with a name, attributes, docstring, and an optional term.

Fields§

§name: String

Name of the object.

§attributes: Vec<Attribute>

List of attributes associated with the object.

§docstring: String

Documentation string for the object.

§term: Option<String>

Optional term associated with the object.

§mixins: Vec<String>

Other objects that this object gets mixed in with.

§position: Option<Position>

The line number of the object

Implementations§

Source§

impl Object

Source

pub fn new(name: String, term: Option<String>) -> Self

Creates a new Object with the given name and optional term.

§Arguments
  • name - A string representing the name of the object.
  • term - An optional string representing a term associated with the object.
§Returns
  • Object - A new instance of the Object struct.
Source

pub fn add_attribute(&mut self, attribute: Attribute)

Adds an attribute to the object.

§Arguments
  • attribute - An instance of Attribute to be added to the object’s attributes.
Source

pub fn set_docstring(&mut self, docstring: String)

Sets the docstring for the object.

§Arguments
  • docstring - A string representing the documentation string for the object.
Source

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

Sets the line number of the object.

§Arguments
  • position - The position to set.
Source

pub fn get_last_attribute(&mut self) -> Option<&mut Attribute>

Retrieves the last attribute added to the object.

§Returns
  • &mut Attribute - A mutable reference to the last attribute.
§Panics

This function will panic if there are no attributes in the object.

Source

pub fn create_new_attribute(&mut self, name: String, required: bool)

Creates and adds a new attribute to the object.

§Arguments
  • name - A string representing the name of the attribute.
  • required - A boolean indicating whether the attribute is required.
Source

pub fn has_attributes(&self) -> bool

Checks if the object has any attributes.

§Returns
  • bool - true if the object has attributes, false otherwise.
Source

pub fn set_name(&mut self, name: String)

Sets the name of the object.

§Arguments
  • name - A string representing the new name of the object.
Source

pub fn has_any_terms(&self) -> bool

Checks if any attribute of the object has a term.

§Returns
  • bool - true if any attribute has a term, false otherwise.
Source

pub fn sort_attrs_by_required(&mut self)

Sorts the attributes of the object by their required field in descending order.

Trait Implementations§

Source§

impl Clone for Object

Source§

fn clone(&self) -> Object

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 Object

Source§

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

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

impl Default for Object

Source§

fn default() -> Object

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Object

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 From<ClassDefinition> for Object

Implements conversion from LinkML ClassDefinition to Object.

Source§

fn from(class: ClassDefinition) -> Self

Converts a LinkML ClassDefinition into an internal Object representation.

This conversion handles:

  • Class metadata (name, description, URI)
  • Local attribute definitions
  • Slot usage patterns and constraints
§Arguments
  • class - The LinkML ClassDefinition to convert
§Returns

An Object representing the class in the internal model format

Source§

impl From<Object> for ClassDefinition

Implements conversion from Object to LinkML ClassDefinition.

Source§

fn from(obj: Object) -> Self

Converts an Object into a LinkML ClassDefinition.

This conversion process handles:

  • Converting attributes to LinkML format
  • Setting up slot usage for pattern constraints
  • Preserving documentation and URI terms
  • Maintaining inheritance relationships
  • Managing attribute constraints and validations
Source§

impl Hash for Object

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Object

Source§

fn eq(&self, other: &Object) -> 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 Object

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<&Object> for SchemaObject

Source§

fn try_from(obj: &Object) -> Result<Self, Self::Error>

Attempts to convert an Object into a SchemaObject.

§Arguments
  • obj - A reference to the Object.
§Returns

A Result containing the SchemaObject or an error message.

Source§

type Error = String

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

impl TryFrom<&Object> for SchemaType

Source§

fn try_from(obj: &Object) -> Result<Self, Self::Error>

Attempts to convert an Object into a SchemaType.

§Arguments
  • obj - A reference to the Object.
§Returns

A Result containing the SchemaType or an error message.

Source§

type Error = String

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

impl TryFrom<SchemaObject> for Object

Converts a JSON Schema object to an Object

This implementation handles the conversion of a schema object’s properties to attributes, and processes required fields.

Source§

type Error = Box<dyn Error>

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

fn try_from(schema_obj: SchemaObject) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl StructuralPartialEq for Object

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, 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>,