<terminated-effect> ( in out terminated? -- effect )

Factor handbook » The language » Stack effect declarations

Factor handbook » The language » Stack effect declarations

Prev: | <effect> ( in out -- effect ) |

Next: | <variable-effect> ( in-var in out-var out -- effect ) |

Vocabulary

effects

Inputs

Outputs

Word description

Constructs an effect object like <effect>. If terminated? is true, the value of out is ignored, and a terminating stack effect is constructed.

Notes

This word cannot construct effects with Stack effect row variables. Use <variable-effect> to construct variable stack effects.

Examples

See also

<effect>, <variable-effect>

Definition

effects

Inputs

in | a sequence of strings or string–type pairs |

out | a sequence of strings or string–type pairs |

terminated? | a boolean |

Outputs

effect | an effect |

Word description

Constructs an effect object like <effect>. If terminated? is true, the value of out is ignored, and a terminating stack effect is constructed.

Notes

This word cannot construct effects with Stack effect row variables. Use <variable-effect> to construct variable stack effects.

Examples

USING: effects prettyprint ;
{ "a" { "b" ( x y -- z ) } } { "c" } f <terminated-effect> .

( a b: ( x y -- z ) -- c )

( a b: ( x y -- z ) -- c )

USING: effects prettyprint ;
{ "a" { "b" ( x y -- z ) } } { } t <terminated-effect> .

( a b: ( x y -- z ) -- * )

( a b: ( x y -- z ) -- * )

See also

<effect>, <variable-effect>

Definition