Skip to main content

IntellijSchemaExt

Struct IntellijSchemaExt 

Source
pub struct IntellijSchemaExt {
    pub html_description: Option<String>,
    pub language_injection: Option<String>,
    pub enum_metadata: Option<BTreeMap<String, EnumValueMeta>>,
}
Expand description

IntelliJ IDEA JSON Schema extensions (x-intellij-*).

IntelliJ-based IDEs recognise these vendor extensions on any JSON Schema property to enhance editing, completion, and validation UX. Each key is a separate top-level property on the schema object, so this struct is #[serde(flatten)]-ed into Schema.

§Keys

JSON keyRust fieldPurpose
x-intellij-html-descriptionhtml_descriptionRich HTML description for hover/docs
x-intellij-language-injectionlanguage_injectionLanguage ID for editor injection
x-intellij-enum-metadataenum_metadataPer-enum-value descriptions

§Example

{
  "type": "string",
  "x-intellij-html-description": "<b>Greeting</b> message",
  "x-intellij-language-injection": "Shell Script",
  "x-intellij-enum-metadata": {
    "system": { "description": "Use system default" }
  }
}

Fields§

§html_description: Option<String>

Rich HTML description shown in editor hover popups and documentation panels.

Analogous to the VSCode markdownDescription extension but uses HTML markup instead of Markdown.

§language_injection: Option<String>

Language identifier for language injection.

When set on a string-typed property, IntelliJ IDEA injects syntax highlighting and code intelligence for the named language (e.g. "Shell Script", "RegExp", "ini").

§enum_metadata: Option<BTreeMap<String, EnumValueMeta>>

Per-enum-value metadata, keyed by the enum value string.

Provides additional descriptions for each enum value that IntelliJ IDEA surfaces in completion popups and documentation panels.

Trait Implementations§

Source§

impl Clone for IntellijSchemaExt

Source§

fn clone(&self) -> IntellijSchemaExt

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 IntellijSchemaExt

Source§

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

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

impl Default for IntellijSchemaExt

Source§

fn default() -> IntellijSchemaExt

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

impl<'de> Deserialize<'de> for IntellijSchemaExt

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 JsonSchema for IntellijSchemaExt

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for IntellijSchemaExt

Source§

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

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 Eq for IntellijSchemaExt

Source§

impl StructuralPartialEq for IntellijSchemaExt

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,