Softanza
StartFrançais
Softanza
StartFrançais
Reference · stzString

DistanceTo()

The distance in chars from the given position to the target.

Basic examples (2)

Softanza
o1 = new stzString("---456---")
# the exclusive gap
? o1.DistanceTo("6", :StartingAt = 4)
# the inclusive XT distance
? o1.DistanceToXT("6", :StartingAt = 4)
Output
1
3

run on 2026-10-02 04:24 inside the library at commit 0e72e2e2c; taken from 308_distanceto.ring(opens in a new tab)

Softanza
o1 = new stzString("[••[•[••]•[•]]••[••]]")
# plain forward distance
? o1.DistanceTo("[", :StartingAt = 1)
# :Next spelling
? o1.DistanceTo( :Next = "[", :StartingAt = 1 )
# :NextNth = [2, char]
? o1.DistanceTo( :NextNth = [ 2, "[" ], :StartingAt = 1 )
# STXT counts the bounds
? o1.DistanceToSTXT("[", :StartingAt = 1)
# STXT :Next
? o1.DistanceToSTXT( :Next = "[", :StartingAt = 1 )
# STXT :NextNth
? o1.DistanceToSTXT( :NextNth = [2, "["], :StartingAt = 1 )
# STXT :Previous
? o1.DistanceToSTXT( :Previous = "[", :StartingAt = 9 )
# STXT :PreviousNth
? o1.DistanceToSTXT( :PreviousNth = [2, "["], :StartingAt = 9 )
# plain :Previous
? o1.DistanceTo( :Previous = "[", :StartingAt = 9 )
# plain :PreviousNth
? o1.DistanceTo( :PreviousNth = [2, "["], :StartingAt = 9 )
Output
2
2
4
4
4
6
4
6
2
4

run on 2026-10-02 04:24 inside the library at commit 0e72e2e2c; taken from 309_distanceto.ring(opens in a new tab)

The extensions of this method

Each extension, and whether it exists for this method; an extension that exists combines with the others (FindSTCS).

Extension
Exists
What it adds · The names
Q
no
does what the method does, then returns the object, so the call can be chained
QQ
no
chains on the next, more specific type of object (the Q ladder)
QQQ
no
chains on the most specific type of object (the Q ladder)
QRT
no
returns the result as an object of the requested type
CS
no
takes a case-sensitivity flag
ST
yes
takes the position to start from (StartingAt) · DistanceToSTXT
IB
no
takes bounds that are included (IncludingBounds)
XT
yes
the extended form: more parameters than the base method · DistanceToXT, DistanceToSTXT
XTT
no
yet another extension: a further extended form, after XT
Z
no
includes the position in what it returns
ZZ
no
returns positions as sections, [start, end]
W
no
selects by a condition
WF
no
selects by a condition, with the expressive keywords (@NextItem, @PreviousItem...)
D
no
takes a direction, forward or backward (Directional)
F
no
takes a function (the condition or the update is given as a function); the forms document also uses F for the future form, which defers the action
Many
no
works on a collection of items instead of one (the plural form)
Except
no
takes exceptions, what to leave out (the exceptional form)
U
no
returns the result without duplication

Every example is a test file of the library, run inside the library for this page; only those whose output kept every promise their file wrote are shown.

See also