Struct EmmyrcDoc 

pub struct EmmyrcDoc {
    pub private_name: Vec<String>,
    pub known_tags: Vec<String>,
    pub syntax: DocSyntax,
    pub rst_primary_domain: Option<String>,
    pub rst_default_role: Option<String>,
}

Fields

private_name: Vec<String>

Treat specific field names as private, e.g. m_* means XXX.m_id and XXX.m_type are private, witch can only be accessed in the class where the definition is located.

known_tags: Vec<String>

List of known documentation tags.

syntax: DocSyntax

Syntax for highlighting documentation.

rst_primary_domain: Option<String>

When syntax is Myst or Rst, specifies primary domain used with RST processor.

rst_default_role: Option<String>

When syntax is Myst or Rst, specifies default role used with RST processor.

Trait Implementations

impl Clone for EmmyrcDoc

fn clone(&self) -> EmmyrcDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmmyrcDoc

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

Formats the value using the given formatter.

impl Default for EmmyrcDoc

fn default() -> EmmyrcDoc

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EmmyrcDoc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for EmmyrcDoc

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 Serialize for EmmyrcDoc

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

where __S: Serializer,

Serialize this value into the given Serde serializer.