SQL::Engine::Collection

Generic Object Container

Generic Object Container

method: clear method: count method: each method: first method: last method: list method: pop method: pull method: push

use SQL::Engine::Collection;

my $collection = SQL::Engine::Collection->new;

# $collection->count;

# 0

Types::Standard

items: ro, opt, ArrayRef[Object]

This package provides a generic container for working with sets of objects.

The clear method clears the collection and returns an empty list.

clear() : Bool

=example-1 clear

# given: synopsis

$collection->clear;

The count method counts and returns the number of items in the collection.

count() : Int

=example-1 count

# given: synopsis

$collection->count;

The each method iterates through the collection executing the callback for each item and returns the set of results.

each(CodeRef $value) : ArrayRef[Any]

=example-1 each

# given: synopsis

$collection->each(sub {
  my ($item) = shift;

  $item
});

The first method returns the first item in the collection.

first() : Maybe[Object]

=example-1 first

# given: synopsis

$collection->first;

The last method returns the last item in the collection.

last() : Maybe[Object]

=example-1 last

# given: synopsis

$collection->last;

The list method returns the collection as a list of items.

list() : ArrayRef

=example-1 list

# given: synopsis

$collection->list;

The pop method removes and returns an item from the tail of the collection.

pop() : Maybe[Object]

=example-1 pop

# given: synopsis

$collection->pop;

The pull method removes and returns an item from the head of the collection.

pull() : Maybe[Object]

=example-1 pull

# given: synopsis

$collection->pull;

The push method inserts an item onto the tail of the collection and returns the count.

push(Object @values) : Int

=example-1 push

# given: synopsis

$collection->push(bless {});

cpanm SQL::Engine

perl -MCPAN -e shell
install SQL::Engine