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

circular_buffer

mutate.circular_buffer

create a circular buffer.

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

backed by a fixed length array.

Functions

create immutable array from this
create a list from this array
§
:
Any
 => 
String 
[Inherited from  Circular_Buffer]
the current state of the buffer
as a string.

redefines:

amount of elements free for writing
amount of elements available for reading
§
:
Any
 => 
unit 
[Inherited from  mutable_element]
stop any further mutations of this element
§
:
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 hierarchy of types. So for Type values, dynamic_type is redefined
to just return Type.type.
enqueue data into the buffer

returns an error if the given sequence is too long to fit into
the buffer entirely
read the elements from the buffer
read a single element from the buffer
§
:
Any
 => 
bool 
[Inherited from  mutable_element]
is this element open, i.e., can it be mutated?
§
:
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.
§(e mutate.circular_buffer.T)
:
Any
 => 
outcome unit 
enqueue a single element into the buffer

returns an error if the new element does not fit into the
buffer

Type Features

§
:
Any
 is
 
[Inherited from  Type]
string representation of this type to be used for debugging.

result has the form "Type of '<name>'", but this might change in the future

redefines:

§
:
Any
 is
 
[Inherited from  Type]
There is no dynamic type of a type instance since this would result in an
endless hierarchy of types, so dynamic_type is redefined to just return
Type.type here.

redefines:

§(T 
type
)
:
Any
 is
 
[Inherited from  Type]
Is this type assignable to a type parameter with constraint `T`?

The result of this is a compile-time constant that can be used to specialize
code for a particular type.

is_of_integer_type(n T : numeric) => T : integer
say (is_of_integer_type 1234) # true
say (is_of_integer_type 3.14) # false

it is most useful in conjunction preconditions or `if` statements as in

pair(a,b T) is

=>

or

val(n T) is

§
:
Any
 is
 
[Inherited from  Type]
name of this type, including type parameters, e.g. 'option (list i32)'.
§(LM 
type
, length i64, init mutate.circular_buffer.type.T)
:
Any
 is
initialize circular buffer
§
:
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`.
last changed: 2024-09-18