Struct ExtDocs 

pub struct ExtDocs {
    pub main: Option<String>,
    pub const_value: Option<String>,
    pub default_value: Option<String>,
    pub enum_values: Option<Vec<Option<String>>>,
}

Documentation text overrides for Taplo hover and completion.

Each field replaces the corresponding auto-generated documentation that Taplo would otherwise derive from the schema.

Fields

main: Option<String>

Primary documentation text, replacing the schema description.

const_value: Option<String>

Documentation for the const value.

default_value: Option<String>

Documentation for the default value.

enum_values: Option<Vec<Option<String>>>

Per-enum-value documentation strings (positional, matching the enum array). None entries leave the default text unchanged.

Trait Implementations

impl Clone for ExtDocs

fn clone(&self) -> ExtDocs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtDocs

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

Formats the value using the given formatter.

impl Default for ExtDocs

fn default() -> ExtDocs

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExtDocs

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ExtDocs

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 ExtDocs

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 ExtDocs

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

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 ExtDocs

impl StructuralPartialEq for ExtDocs