Struct Link

pub struct Link {
    pub to_key: String,
    pub dialogue: String,
}

A Link is a uni-directional path to a Node with descriptor dialogue.

Fields

to_key: String

A key to the node being linked. This should be identical to an existing Node#key.

dialogue: String

The dialogue used to describe this link.

Implementations

impl Link

pub fn new<T>(to_key: T, dialogue: T) -> Link

where T: Into<String>,

Returns a Link which maps to a Node with descriptor dialogue.

Arguments

• to_key - A string type that holds an identical Node#key to which this Link corresponds.
• dialogue - A string type that holds associated descriptor dialogue.

Examples

use convo::Link;
let link = Link::new("end", "Goodbye!");

pub fn link<T>(from: &mut Node, to: &Node, dialogue: T)

where T: Into<String>,

Link two Nodes together by creating a Link with descriptor dialogue.

Arguments

• from - A Node which will prompt the link
• to - A Node which will be the target of the link
• dialogue - A string type that holds associated dialogue

Examples

use convo::{Node, Link};
let mut node1 = Node::new("root", "I am the root node!");
let node2 = Node::new("end", "I am the last node!");
Link::link(&mut node1, &node2, "I link start to end!");

Trait Implementations

impl Clone for Link

fn clone(&self) -> Link

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Link

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

Formats the value using the given formatter.

impl PartialEq for Link

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

impl StructuralPartialEq for Link