Enum Edge 

pub enum Edge {
    Walk {
        id: EdgeId,
        a: NodeId,
        b: NodeId,
        one_way: Option<Direction>,
        shortcut: bool,
        gating: Option<EdgeGating>,
    },
    Stair {
        id: EdgeId,
        a: NodeId,
        b: NodeId,
        one_way: Option<Direction>,
        shortcut: bool,
        gating: Option<EdgeGating>,
    },
    Drop {
        id: EdgeId,
        a: NodeId,
        b: NodeId,
        falls: Direction,
        shortcut: bool,
        gating: Option<EdgeGating>,
    },
    Barred {
        id: EdgeId,
        a: NodeId,
        b: NodeId,
        opens_from: OpensFrom,
        one_way: Option<Direction>,
        shortcut: bool,
        gating: EdgeGating,
    },
    Vision {
        id: EdgeId,
        a: NodeId,
        b: NodeId,
    },
}

A connection between two places.

Internally tagged on class, in the same shape every other tagged union in this DSL uses. The tagging is load-bearing rather than stylistic: falls belongs to a drop and opens_from belongs to a barred way, and writing either on a walk would be a declaration nothing reads. Under the tag, serde’s deny_unknown_fields refuses it as an ordinary DW0100 — so the illegal state is unrepresentable and no diagnostic has to police it.

Variants

Walk

A way a body walks, at grade.

Fields

id: EdgeId

Edge id (edge/<kebab>), unique within the graph.

a: NodeId

One end.

b: NodeId

The other end.

one_way: Option<Direction>

Declared directionality; absent means a body passes both ways.

shortcut: bool

This connection exists to close a loop (DW0820).

gating: Option<EdgeGating>

What a body must hold to pass.

Stair

A way a body climbs or descends on built treads.

Fields

id: EdgeId

Edge id (edge/<kebab>), unique within the graph.

a: NodeId

One end.

b: NodeId

The other end.

one_way: Option<Direction>

Declared directionality; absent means a body passes both ways.

shortcut: bool

This connection exists to close a loop (DW0820).

gating: Option<EdgeGating>

What a body must hold to pass.

Drop

A fall. One-way by construction, which is why the direction is required here and optional on its siblings: a body that has dropped cannot climb back up the way it came.

Fields

id: EdgeId

Edge id (edge/<kebab>), unique within the graph.

a: NodeId

One end.

b: NodeId

The other end.

falls: Direction

Which way it falls.

shortcut: bool

This connection exists to close a loop (DW0820).

gating: Option<EdgeGating>

What a body must hold to pass.

Barred

A sealed connection some effect opens.

Fields

id: EdgeId

Edge id (edge/<kebab>), unique within the graph.

a: NodeId

One end.

b: NodeId

The other end.

opens_from: OpensFrom

Which side can open it. The one-side-openable door is spelled here, and it is a property of the connection rather than of any campaign’s fiction.

one_way: Option<Direction>

Declared directionality once open; absent means both ways.

shortcut: bool

This connection exists to close a loop (DW0820).

gating: EdgeGating

What opens it. Required to say something (DW0818): a barred way nothing opens is a wall, and a barred way anything opens is not barred.

Vision

A line of sight between two places, in either direction. Carries no body, so it is not a traversal edge and the reachability closure never walks it; stage 4 gives it a sightline rather than a seam (spec-0049 §4.4).

Fields

id: EdgeId

Edge id (edge/<kebab>), unique within the graph.

a: NodeId

One end.

b: NodeId

The other end.

Implementations

impl Edge

pub fn id(&self) -> &EdgeId

The edge’s id.

pub fn a(&self) -> &NodeId

The a end.

pub fn b(&self) -> &NodeId

The b end.

pub fn class(&self) -> &'static str

The class name as the document spells it.

pub fn is_traversal(&self) -> bool

True if a body passes along this edge. A vision edge does not.

pub fn direction(&self) -> Option<Direction>

Which way a body may pass, or None for both ways (and for a vision edge, which carries none).

pub fn shortcut(&self) -> bool

True if this edge is marked as closing a loop.

pub fn gating(&self) -> Option<&EdgeGating>

What a body must hold to pass, or None where the edge demands nothing.

Trait Implementations

impl Clone for Edge

fn clone(&self) -> Edge

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Edge

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Edge

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Edge

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 PartialEq for Edge

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Edge

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 Edge