§tiro::array

Refers to an array value.

#include "tiropp/objects.hpp"

Inherits from handle

§Public Functions

	Name
	array(handle h)
	array(const array & ) =default
	array(array && ) =default
array &	operator=(const array & ) =default
array &	operator=(array && ) =default
size_t	size() const Returns the number of elements in this array.
handle	get(size_t index) const Returns the value at the given index (`0 <= index < size`).
void	set(size_t index, const handle & value) Sets the value at the given index (`0 <= index < size`) to `value`.
void	push(const handle & value) Appends `value` at the end of the array.
void	pop() Removes the last element from the array.
void	clear() Removes all elements from the array.

Protected Classes inherited from handle

	Name
struct	check_kind_t

Public Functions inherited from handle

	Name
template <typename T > T	as() const Converts this value to the target type.
template <typename T > T	as() Converts this value to the target type.
	handle(tiro_vm_t raw_vm) Constructs a new handle instance.
	handle(const handle & other) Constructs a new handle and initialize is it with the same value as `other`.
	handle(handle && other) =default Move constructs a handle.
	~handle() =default
bool	valid() const Returns true if this handle points to an object (i.e. it was not moved from).
value_kind	kind() const Returns the kind of the value currently held by this handle.
template <typename T > bool	is() const Returns true if this value is of the target type.
type	type_of() const Returns the type of the value currently held by this handle.
string	to_string() const Returns a string that represents the current value.
tiro_vm_t	raw_vm() const Returns the raw vm instance associated with this handle.
tiro_handle_t	raw_handle() const Returns the raw handle instance (nullptr for invalid handles).

Protected Functions inherited from handle

	Name
	handle(check_kind_t , handle && other, value_kind expected)

Protected Attributes inherited from handle

	Name
constexpr check_kind_t	check_kind

inline explicit array(
    handle h
)

array(
    const array & 
) =default

array(
    array && 
) =default

array & operator=(
    const array & 
) =default

array & operator=(
    array && 
) =default

inline size_t size() const

Returns the number of elements in this array.

inline handle get(
    size_t index
) const

Returns the value at the given index (0 <= index < size).

inline void set(
    size_t index,
    const handle & value
)

Sets the value at the given index (0 <= index < size) to value.

inline void push(
    const handle & value
)

Appends value at the end of the array.

inline void pop()

Removes the last element from the array.

inline void clear()

Removes all elements from the array.

Updated on 2022-02-27 at 21:17:13 +0100