Skip to main content

CjsComponent

Struct CjsComponent 

Source
pub struct CjsComponent {
    pub iri: String,
    pub component_type: ComponentType,
    pub require_element: Option<String>,
    pub comment: Option<String>,
    pub parameters: Vec<CjsParameter>,
    pub extends: Vec<String>,
    pub constructor_arguments: Option<JsonLdVal>,
    pub module_iri: Option<String>,
    pub source_file: String,
    pub iri_span: Range<usize>,
}
Expand description

A CJS component — a class, abstract class, or singleton instance declared inside a module.

Returned by [ComponentRegistry] and used for:

  • Autocompletion of @type values in config files (all variants)
  • Hover documentationcomment provides the description
  • Goto-definitionsource_file + iri_span points to the @id in the file where this component is defined (may differ from the module’s entry-point file when components are split across imported sub-files)
  • Parameter completionparameters drives key completion inside config instance objects

Fields§

§iri: String

Fully expanded IRI identifying this component.

§component_type: ComponentType§require_element: Option<String>

The JavaScript export name to require (from oo:componentPath).

§comment: Option<String>

Human-readable description from rdfs:comment — shown in hover cards.

§parameters: Vec<CjsParameter>

Constructor parameters for this component (own + inherited via finalize).

§extends: Vec<String>

IRIs of parent classes (from rdfs:subClassOf). Populated so the LSP can show the full inheritance chain and resolve inherited parameters.

§constructor_arguments: Option<JsonLdVal>

Raw constructor arguments descriptor (kept for completeness).

§module_iri: Option<String>

IRI of the module that declares this component.

§source_file: String

Absolute path to the file where this component’s @id is defined. This is the correct target for goto-definition; it may differ from CjsModule::source_file when the module imports component sub-files.

§iri_span: Range<usize>

Byte range of the @id value for this component in source_file.

Trait Implementations§

Source§

impl Clone for CjsComponent

Source§

fn clone(&self) -> CjsComponent

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 CjsComponent

Source§

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

Formats the value using the given formatter. Read more

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