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 key | Rust field | Purpose |
|---|---|---|
x-intellij-html-description | html_description | Rich HTML description for hover/docs |
x-intellij-language-injection | language_injection | Language ID for editor injection |
x-intellij-enum-metadata | enum_metadata | Per-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
impl Clone for IntellijSchemaExt
Source§fn clone(&self) -> IntellijSchemaExt
fn clone(&self) -> IntellijSchemaExt
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for IntellijSchemaExt
impl Debug for IntellijSchemaExt
Source§impl Default for IntellijSchemaExt
impl Default for IntellijSchemaExt
Source§fn default() -> IntellijSchemaExt
fn default() -> IntellijSchemaExt
Source§impl<'de> Deserialize<'de> for IntellijSchemaExt
impl<'de> Deserialize<'de> for IntellijSchemaExt
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl JsonSchema for IntellijSchemaExt
impl JsonSchema for IntellijSchemaExt
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
$ref keyword. Read moreSource§impl PartialEq for IntellijSchemaExt
impl PartialEq for IntellijSchemaExt
Source§impl Serialize for IntellijSchemaExt
impl Serialize for IntellijSchemaExt
impl Eq for IntellijSchemaExt
impl StructuralPartialEq for IntellijSchemaExt
Auto Trait Implementations§
impl Freeze for IntellijSchemaExt
impl RefUnwindSafe for IntellijSchemaExt
impl Send for IntellijSchemaExt
impl Sync for IntellijSchemaExt
impl Unpin for IntellijSchemaExt
impl UnsafeUnpin for IntellijSchemaExt
impl UnwindSafe for IntellijSchemaExt
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.