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

Circular_Buffer

container.Circular_Buffer

(T 
type
:
Type, E 
type
:
Type)
 ref
:
Any
 is
[Contains abstract features]
[Private constructor]
Circular_Buffer -- a circular buffer-like structure

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

it is usually backed by a fixed length array.

Type Parameters

effect used to modify this buffer

Functions

 => 
array T
[Abstract feature]
create immutable array from this buffer
create a list from this buffer
 => 
String
[Redefinition of  Any.as_string]
the current state of the buffer
as a string.

redefines:

 => 
i64
[Abstract feature]
amount of elements free for writing
 => 
i64
[Abstract feature]
amount of elements available for reading
 => 
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.
(s Sequence T)
 => 
outcome unit
[Abstract feature]
enqueue data into the buffer

returns an error if the given sequence is too long to fit into
the buffer entirely
(n i64)
 => 
array T
[Abstract feature]
read elements from the buffer
 => 
option T
[Abstract feature]
read a single element from the buffer
 => 
i64
[Abstract feature]
length of this buffer.
 => 
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 T)
 => 
outcome unit
[Abstract feature]
enqueue a single element into the buffer

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

Type Functions

 => 
String
[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:

 => 
Type
[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
:
Type)
 => 
bool
[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.


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


or

 => 
String
[Inherited from  Type]
name of this type, including type parameters, e.g. 'option (list i32)'.
 => 
String
[Inherited from  Type]
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.

NYI: Redefinition allows the type feature to be distinguished from its normal counterpart, see #3913

redefines:

 => 
Type
[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`.
0.095dev (2025-08-15 12:02:22 GIT hash 301b5b75e77076d091b38f555473f9f0e31e5b5c built by fridi@fzen)
last changed: 2025-08-15