Struct zamm_yang::tao::relation::attribute::DualPurposeDocumentation

pub struct DualPurposeDocumentation { /* fields omitted */ }

Dual-purpose documentation that can be used in more than one situation.

For example, the same substring might be usable for both the getter and setter of a string.

Methods from Deref<Target = FinalNode>

pub fn inheritance_wrapper(&self) -> &InheritanceNode

Leak inheritance-level functionality.

pub fn base_wrapper(&self) -> &BaseNode

Leak base-level functionality.

Methods from Deref<Target = InheritanceNode>

pub fn base_wrapper(&self) -> &BaseNode

Leak base-level functionality.

Methods from Deref<Target = BaseNode>

Trait Implementations

impl ArchetypeTrait for DualPurposeDocumentation

type ArchetypeForm = AttributeArchetype

The Form that will be used to reason about this node and its children as archetypes and subtypes.

type Form = DualPurposeDocumentation

The Form that will be used to reason about this node's leaves as individuals. Unless you are the Tao, this should be the same as the type that ArchetypeTrait is being implemented on.

pub const TYPE_ID: usize

The ID for this archetype.

pub const TYPE_NAME: &'static str

The name of this archetype.

pub const PARENT_TYPE_ID: usize

The default parent this archetype inherits from. Every archetype should have at least one parent, so that it doesn't live in a separate universe of its own. This helps enforce that, since allocations are not allowed in Rust constants.

pub fn archetype() -> Self::ArchetypeForm

The incarnation of this archetype as a form.

pub fn new() -> Self::Form

In the beginning was the Oneness, and the Oneness was nothingness.

impl AttributeTrait for DualPurposeDocumentation

type OwnerForm = Implement

The Form representing the owner.

type ValueForm = StrConcept

The Form representing the value.

pub fn set_owner(&mut self, owner: &Self::OwnerForm)

Set the owner for this attribute.

pub fn owner(&self) -> Option<Self::OwnerForm>

The owner of an attribute, if it exists.

pub fn set_value(&mut self, value: &Self::ValueForm)

Set the value for this attribute.

pub fn value(&self) -> Option<Self::ValueForm>

The value of an attribute, if it exists.

impl Clone for DualPurposeDocumentation

pub fn clone(&self) -> DualPurposeDocumentation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for DualPurposeDocumentation

impl Debug for DualPurposeDocumentation

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

Formats the value using the given formatter.

impl Deref for DualPurposeDocumentation

type Target = FinalNode

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for DualPurposeDocumentation

pub fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Eq for DualPurposeDocumentation

impl FormTrait for DualPurposeDocumentation

pub fn ego_death(&self) -> Tao

Jung called, and you answered. It is time to let go of your individuality and return to the Oneness from which you once came. There is no life or death, there is no existence or non-existence, there is no form or abstraction. Forget all preconceptions, blur all boundaries, be at peace with the universe again.

pub fn as_form(&self) -> Form

A less severe form of ego-death, where you still remember that you exist.

pub fn add_parent(&mut self, parent: Archetype)

Set a parent archetype. The current archetype will inherit all attributes of the parent archetype.

pub fn is_individual(&self) -> bool

Whether this represents an individual.

pub fn parents(&self) -> Vec<Archetype, Global>

Get all direct parent archetypes of this concept.

pub fn ancestry(&self) -> Vec<Archetype, Global>

Get the shortest chain of ancestors that leads back to Tao, starting with Tao itself.

pub fn has_parent(&self, possible_ancestor: Archetype) -> bool

Checks to see if another archetype is a direct parent of this one.

pub fn has_ancestor(&self, possible_ancestor: Archetype) -> bool

Checks to see if another archetype is an ancestor of this one. If so, the current archetype will inherit all attributes of the ancestor.

pub fn meta(&self) -> Self::ArchetypeForm

View the current node from its meta perspective.

pub fn meta_archetype(&self) -> Archetype

Get the node representing the current node's meta-perspective.

pub fn specific_meta(&mut self) -> Archetype

Grab the meta-perspective that's specific to the current type. If it doesn't exist yet, then it will be created.

pub fn has_specific_meta(&self) -> bool

Whether or not this type has its own specific meta. If it doesn't, that means its meta object is inherited.

pub fn set_meta_archetype(&mut self, archetype: &Archetype)

Set the meta-form for this Form.

pub fn mark_individual(&mut self)

Mark this concept as representing an individual.

impl From<DualPurposeDocumentation> for Tao

pub fn from(this: DualPurposeDocumentation) -> Tao

Performs the conversion.

impl From<DualPurposeDocumentation> for Relation

pub fn from(this: DualPurposeDocumentation) -> Relation

Performs the conversion.

impl From<DualPurposeDocumentation> for Attribute

pub fn from(this: DualPurposeDocumentation) -> Attribute

Performs the conversion.

impl From<FinalNode> for DualPurposeDocumentation

pub fn from(f: FinalNode) -> Self

Performs the conversion.

impl From<usize> for DualPurposeDocumentation

pub fn from(id: usize) -> Self

Performs the conversion.

impl Hash for DualPurposeDocumentation

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for DualPurposeDocumentation

pub fn cmp(&self, other: &DualPurposeDocumentation) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<DualPurposeDocumentation> for DualPurposeDocumentation

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<DualPurposeDocumentation> for DualPurposeDocumentation

pub fn partial_cmp(&self, other: &DualPurposeDocumentation) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &DualPurposeDocumentation) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &DualPurposeDocumentation) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &DualPurposeDocumentation) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &DualPurposeDocumentation) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for DualPurposeDocumentation

impl StructuralPartialEq for DualPurposeDocumentation

impl<'a> TryFrom<&'a str> for DualPurposeDocumentation

type Error = String

The type returned in the event of a conversion error.

pub fn try_from(name: &'a str) -> Result<Self, Self::Error>

Performs the conversion.