Struct Entity 

pub struct Entity<C: EntityCategory> {
    pub id: EntityId,
    pub category: C,
    pub title: String,
    pub doc: Option<String>,
    pub source_span: Option<Span>,
    pub body: EntityBody,
}

Parser-side entity with a family-typed category.

In-memory view produced by contract-family parsers. Convert to wire StoredEntity when building a ReferenceManual.

Fields

id: EntityId

Entity address within the loaded contract.

category: C

Family-specific typed category marker.

title: String

Human-readable entity title.

doc: Option<String>

Leading documentation prose, when present.

source_span: Option<Span>

Source span within the input document, when available.

Parser-local provenance; maps to wire Source at serialize time.

body: EntityBody

Category-specific entity payload.

Trait Implementations

impl<C: Clone + EntityCategory> Clone for Entity<C>

fn clone(&self) -> Entity<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug + EntityCategory> Debug for Entity<C>

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

Formats the value using the given formatter.

impl<C: Eq + EntityCategory> Eq for Entity<C>

impl<C: PartialEq + EntityCategory> PartialEq for Entity<C>

fn eq(&self, other: &Entity<C>) -> 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<C: PartialEq + EntityCategory> StructuralPartialEq for Entity<C>