### Navigation

- index
- Ada modules |
- next |
- previous |
- Ahven 2.2 documentation »
- API Documentation for Ahven »

# `Ahven.SList` – Package

New in version 1.4.

## Types

### List

    type List is new Ada.Finalization.Controlled with private;

### Cursor

    type Cursor is private;

### Count_Type

    subtype Count_Type is Natural;

## Exceptions

### Invalid_Cursor

    Invalid_Cursor : exception;

Raised when the cursor given as a parameter is invalid. For example, calling Data (Pos) when Is_Valid (Pos) returns False causes the exception to be raised.

### List_Full

    List_Full : exception;

Raised when the size of the list exceeds Count_Type’Last.

## Procedures and Functions

### Append

    procedure Append (Target : in out List; Node_Data : Element_Type);

Append an element at the end of the list.

### Clear

Changed in version 1.8: Previously Clear was called Remove_All.

    procedure Clear (Target : in out List);

Remove all elements from the list.

### First

    function First (Target : List) return Cursor;

Return a cursor to the first element of the list.

### Next

    function Next (Position : Cursor) return Cursor;

Move the cursor to point to the next element on the list.

### Data

    function Data (Position : Cursor) return Element_Type;

Return element pointed by the cursor.

### Is_Valid

    function Is_Valid (Position : Cursor) return Boolean;

Tell the validity of the cursor. The cursor will become invalid when you iterate it over the last item.

### Length

    function Length (Target : List) return Count_Type;

Return the length of the list.

### For_Each

New in version 1.8.

    generic
       with procedure Action (T : in out Element_Type) is <>;
    procedure For_Each (Target : List);

A generic procedure for walk through every item in the list and call Action procedure for them.

### Navigation

- index
- Ada modules |
- next |
- previous |
- Ahven 2.2 documentation »
- API Documentation for Ahven »