Header menu logo Nu

'a Relation Type

A relation that can be resolved to an address via contextual resolution. OPTIMIZATION: Links is an array only for speed; it is invalid to mutate it.

Record fields

Record Field Description

Links

Full Usage: Links

Field type: Link array
Field type: Link array

Static members

Static member Description

Relation.equals relation relation2

Full Usage: Relation.equals relation relation2

Parameters:
Returns: bool

Equate Relations.

relation : 'a Relation
relation2 : 'a Relation
Returns: bool

Relation.hash relation

Full Usage: Relation.hash relation

Parameters:
Returns: int

Hash a Relation.

relation : 'a Relation
Returns: int

Relation.makeFromAddress address

Full Usage: Relation.makeFromAddress address

Parameters:
Returns: 'a Relation

Make a relation from an address.

address : 'a Address
Returns: 'a Relation

Relation.makeFromArray names

Full Usage: Relation.makeFromArray names

Parameters:
    names : string array

Returns: 'a Relation

Make a relation from an array of names.

names : string array
Returns: 'a Relation

Relation.makeFromList names

Full Usage: Relation.makeFromList names

Parameters:
    names : string list

Returns: 'a Relation

Make a relation from a list of names.

names : string list
Returns: 'a Relation

Relation.makeFromString relationStr

Full Usage: Relation.makeFromString relationStr

Parameters:
    relationStr : string

Returns: 'a Relation

Make a relation from a '/' delimited string. NOTE: do not move this function as the RelationConverter's reflection code relies on it being exactly here!

relationStr : string
Returns: 'a Relation

Relation.relate address address2

Full Usage: Relation.relate address address2

Parameters:
Returns: 'b Relation

Relate the second address to the first.

address : 'a Address
address2 : 'b Address
Returns: 'b Relation

Relation.resolve address relation

Full Usage: Relation.resolve address relation

Parameters:
Returns: 'b Address

Resolve a relation from an address.

address : 'a Address
relation : 'b Relation
Returns: 'b Address

Type something to start searching.