Struct TaploSchemaExt 

pub struct TaploSchemaExt {
    pub hidden: Option<bool>,
    pub links: Option<ExtLinks>,
    pub docs: Option<ExtDocs>,
    pub init_keys: Option<Vec<String>>,
    pub plugins: Vec<String>,
    pub extra: BTreeMap<String, Value>,
}

Taplo JSON Schema extension (x-taplo).

Controls editor behavior in the Taplo TOML language server: documentation text, completion links, hidden fields, and plugins. Serialized as a single nested JSON object under the x-taplo key.

Compatible with taplo-common’s SchemaExt.

Example

{
  "x-taplo": {
    "hidden": true,
    "docs": { "main": "Override description" },
    "links": { "key": "https://example.com" }
  }
}

Fields

hidden: Option<bool>

When true, the property is hidden from completion suggestions.

links: Option<ExtLinks>

Navigation link targets shown as clickable references in the editor.

docs: Option<ExtDocs>

Documentation text overrides for hover popups and completion details.

init_keys: Option<Vec<String>>

Keys to insert when creating a new table from this schema.

plugins: Vec<String>

Taplo plugin names to activate when this schema is in use.

extra: BTreeMap<String, Value>

Trait Implementations

impl Clone for TaploSchemaExt

fn clone(&self) -> TaploSchemaExt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TaploSchemaExt

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

Formats the value using the given formatter.

impl Default for TaploSchemaExt

fn default() -> TaploSchemaExt

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TaploSchemaExt

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for TaploSchemaExt

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for TaploSchemaExt

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

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

Generates a JSON Schema for this type.

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.

impl PartialEq for TaploSchemaExt

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for TaploSchemaExt

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TaploSchemaExt

impl StructuralPartialEq for TaploSchemaExt