Struct Entity 

pub struct Entity {
    pub title: Option<String>,
    pub description: MarkdownString,
    pub kind: String,
    pub identity: Identity,
    pub members: Vec<Entity>,
    pub member_context: Option<String>,
    pub language: String,
    pub source: Source,
    pub meta: Value,
}

Fields

title: Option<String>

The title for the entity. Usually the name of the class/function/module, etc.

description: MarkdownString

A description for the entity. Supports Markdown.

kind: String

The type of the entity. E.g. function, class, module. Each language will have a different set of entities.

identity: Identity

The identity of the entity: either its fully qualified name, or a reference to another entity via its fully qualified name.

E.g. a class declaration will have an identity of its fully qualified name, but a function’s return position will have an reference to another entity that describes its type.

members: Vec<Entity>

Child entities. E.g. classes may contain functions, modules may have child modules, etc.

member_context: Option<String>

What context the entity is in. E.g. a type may be describing a parameter to a function, or a return type.

language: String

The language of the entity

source: Source

The language of the entity

meta: Value

Arbitrary metadata different types of entities need to store

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl PartialEq for Entity

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Entity