Fuzion Logo
fuzion-lang.dev — The Fuzion Language Portal
JavaScript seems to be disabled. Functionality is limited.

mutate

mutate

mutate -- an effect that permits creation and mutation of mutable values.

This effect is typically used to work with mutable values. You can create
a mutable value as follows

v := mutate.env.new i32 42

and then modify it using

v <- 666

To read it, call 'get' as in

say "v is {v.get}"

Convenience feature 'mut' and type inference allow the creation to be
written as

v := mut 42

NYI: syntax sugar to read mutable field using

w := v + 1

instead of

w := v.get + 1

is not supported yet.

Value Constructors

§(T 
type
, mutable_value mutate.new.T)
:
mutable_element,auto_unwrap mutate.new.T, mutate
 is
create a new mutable value with the given initial value and update the
'mutate' effect in the current environment

Functions

§
:
Any
 => 
void 
[Inherited from  effect]
replace effect in the current context by this and abort current execution
does this effect support abort?

redefines:

§
:
Any
 => 
String 
[Inherited from  Any]
create a String from this instance. Unless redefined, `a.as_string` will
create `"instance[T]"` where `T` is the dynamic type of `a`
§
:
Any
 => 
Type 
[Inherited from  Any]
Get the dynamic type of this instance. For value instances `x`, this is
equal to `type_of x`, but for `x` with a `ref` type `x.dynamic_type` gives
the actual runtime type, while `type_of x` results in the static
compile-time type.

There is no dynamic type of a type instance since this would result in an
endless hierachy of types. So for Type values, dynamic_type is redefined
to just return Type.type.
§(T 
type
, f Function simple_effect.go.T)
:
Any
 => 
simple_effect.go.T 
[Inherited from  simple_effect]
install this effect and run code that produces a result of
type T. panic in case abort is called.
§
:
Any
 => 
effect_mode.val 
[Inherited from  effect]
§
:
Any
 => 
String 
[Inherited from  Type]
name of this type, including type parameters, e.g. 'option (list i32)'.
§
:
Any
 => 
String 
[Inherited from  Any]
convenience prefix operator to create a string from a value.

This permits usage of `$` as a prefix operator in a similar way both
inside and outside of constant strings: $x and "$x" will produce the
same string.
§
:
Any
 => 
void 
[Inherited from  effect]
abort the current execution and return from the surrounding call to
abortable with result == false.
§(R 
type
, f Function effect.run.R, def Function effect.run.R)
:
Any
 => 
effect.run.R 
[Inherited from  effect]
execute the code of 'f' in the context of this effect
§(code Function unit)
:
Any
 => 
unit 
[Inherited from  simple_effect]
install this simple_effect and run code

In case of an `abort`, `use` returns silently (NYI: maybe this should better
return an oucome with the abort wrapped in an error?).

Value Types

create a mutable array.
create a mutable array with two dimensions.
create a circular buffer.

buffer to which elements can be enqueued and retrieved with a FIFO
logic.

backed by a fixed length array.
common type for mutable data
create a new mutable value with the given initial value and update the
'mutate' effect in the current environment

Type Features

§
:
Any
 is
 
[Inherited from  effect]
has an effect of the given type been installed?
§(E 
type
)
:
Any
 is
 
[Inherited from  effect]
has an effect of the given type been installed?
§
:
Any
 is
 
[Inherited from  Any]
Get a type as a value.

This is a feature with the effect equivalent to Fuzion's `expr.type` call tail.
It is recommended to use `expr.type` and not `expr.type_value`.

`type_value` is here to show how this can be implemented and to illustrate the
difference to `dynamic_type`.