Tinderbox v9 Icon


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Last Altered: 

 Function  [other Function type actions]

 Item  [operators of similar scope]

 Stream parsing  [other Stream parsing operators]


 As at baseline

Syntax note: Operators without any defined mandatory arguments may omit their empty closing parentheses



The fail operator makes an explicit declaration of a failure, and if invoked only ever returns false.

Often, in stream processing a failure occurs implicitly, for example because the end of the processed string is reached without finding the desired data. However, sometimes, there is a definite need to signal failure; for example, because the parsed data are invalid.

For example:

	   if($TheWord.contains("None")) {

The above skips through $MyString to the first colon and then captures the next discrete word after the colon into $TheWord. The action fails if: