Venus::Unpack

Unpack Class

Unpack Class for Perl 5

method: all method: arg method: args method: array method: cast method: checks method: copy method: first method: from method: get method: into method: last method: list method: move method: name method: one method: reset method: set method: signature method: types method: use method: validate

package main;

use Venus::Unpack;

my $unpack = Venus::Unpack->new(args => ["hello", 123, 1.23]);

# my $args = $unpack->all->types('string', 'number', 'float')->args;

# ["hello", 123, 1.23]

This package provides methods for validating, coercing, and otherwise operating on lists of arguments.

Venus::Kind::Utility

The all method selects all arguments for processing returns the invocant.

all() (Venus::Unpack)

{ since => '2.01', }

=example-1 all

# given: synopsis

package main;

$unpack = $unpack->all;

# bless(..., 'Venus::Unpack')

The arg method returns the argument at the index specified.

arg(string $index) (any)

{ since => '2.01', }

=example-1 arg

# given: synopsis

package main;

my $arg = $unpack->arg(0);

# "hello"

The args method returns all arugments as an arrayref, or list in list context. If arguments are provided they will overwrite the existing arugment list.

args(any @args) (arrayref)

{ since => '2.01', }

=example-1 args

# given: synopsis

package main;

my $args = $unpack->args;

# ["hello", 123, 1.23]

The array method returns the argument list as a Venus::Array object.

array() (Venus::Array)

{ since => '2.01', }

=example-1 array

# given: synopsis

package main;

my $array = $unpack->array;

# bless(..., 'Venus::Array')

The cast method processes the selected arguments, passing each value to the class name specified, or the "cast" in Venus::Type method, and returns results.

cast(string $name) (arrayref)

{ since => '2.01', }

=example-1 cast

# given: synopsis

package main;

my $cast = $unpack->all->cast;

# [
#   bless(..., 'Venus::String'),
#   bless(..., 'Venus::Number'),
#   bless(..., 'Venus::Float'),
# ]

The checks method processes the selected arguments, passing each value to the "check" in Venus::Assert method with the type expression provided, and returns results.

checks(string @types) (arrayref)

{ since => '2.01', }

=example-1 checks

# given: synopsis

package main;

my $checks = $unpack->all->checks('string');

# [true, false, false]

The copy method copies values from the arugment list as properties of the underlying object and returns the invocant.

copy(string @pairs) (Venus::Unpack)

{ since => '2.01', }

=example-1 copy

# given: synopsis

package main;

$unpack = $unpack->copy(0 => 'arg1');

# bless({..., arg1 => 'hello'}, 'Venus::Unpack')

The first method selects the first argument for processing returns the invocant.

first() (Venus::Unpack)

{ since => '2.01', }

=example-1 first

# given: synopsis

package main;

$unpack = $unpack->first;

# bless(..., 'Venus::Unpack')

The from method names the source of the unpacking operation and is used in exception messages whenever the "signature" in Venus::Unpack operation fails. This method returns the invocant.

from(string $data) (Venus::Unpack)

{ since => '2.23', }

=example-1 from

# given: synopsis

package main;

$unpack = $unpack->from;

# bless(..., 'Venus::Unpack')

The get method returns the argument at the index specified.

get(string $index) (any)

{ since => '2.01', }

=example-1 get

# given: synopsis

package main;

my $get = $unpack->get;

# undef

The into method processes the selected arguments, passing each value to the class name specified, and returns results.

into(string @args) (any)

{ since => '2.01', }

=example-1 into

# given: synopsis

package main;

my $cast = $unpack->all->into('Venus::String');

# [
#   bless(..., 'Venus::String'),
#   bless(..., 'Venus::String'),
#   bless(..., 'Venus::String'),
# ]

The last method selects the last argument for processing returns the invocant.

last() (Venus::Unpack)

{ since => '2.01', }

=example-1 last

# given: synopsis

package main;

$unpack = $unpack->last;

# bless(..., 'Venus::Unpack')

The list method returns the result of the dispatched method call as an arrayref, or list in list context.

list(string | coderef $code, any @args) (arrayref)

{ since => '2.01', }

=example-1 list

# given: synopsis

package main;

my (@args) = $unpack->all->list('cast');

# (
#   bless(..., 'Venus::String'),
#   bless(..., 'Venus::Number'),
#   bless(..., 'Venus::Float'),
# )

The move method moves values from the arugment list, reducing the arugment list, as properties of the underlying object and returns the invocant.

move(string @pairs) (Venus::Unpack)

{ since => '2.01', }

=example-1 move

# given: synopsis

package main;

$unpack = $unpack->move(0 => 'arg1');

# bless({..., arg1 => 'hello'}, 'Venus::Unpack')

The name method names the unpacking operation and is used in exception messages whenever the "signature" in Venus::Unpack operation fails. This method returns the invocant.

name(string $data) (Venus::Unpack)

{ since => '2.23', }

=example-1 name

# given: synopsis

package main;

$unpack = $unpack->name;

# bless(..., 'Venus::Unpack')

The one method returns the first result of the dispatched method call.

one(string | coderef $code, any @args) (any)

{ since => '2.01', }

=example-1 one

# given: synopsis

package main;

my $one = $unpack->all->one('cast');

# (
#   bless(..., 'Venus::String'),
# )

The reset method resets the arugments list (if provided) and deselects all arguments (selected for processing) and returns the invocant.

reset(any @args) (Venus::Unpack)

{ since => '2.01', }

=example-1 reset

# given: synopsis

package main;

$unpack = $unpack->all->reset;

# bless(..., 'Venus::Unpack')

The set method assigns the value provided at the index specified and returns the value.

set(string $index, any $value) (any)

{ since => '2.01', }

=example-1 set

# given: synopsis

package main;

my $set = $unpack->set;

# ["hello", 123, 1.23]

The signature method processes the selected arguments, passing each value to the "validate" in Venus::Assert method with the type expression provided and throws an exception on failure and otherise returns the results as an arrayref, or as a list in list context.

signature(string $name, string @types) (arrayref)

{ since => '2.01', }

=example-1 signature

# given: synopsis

package main;

my ($string, $number, $float) = $unpack->all->name('example-1')->signature(
  'string | number | float',
);

# ("hello", 123, 1.23)

The types method processes the selected arguments, passing each value to the "validate" in Venus::Assert method with the type expression provided, and unlike the "validate" method returns the invocant.

types(string @types) (Venus::Unpack)

{ since => '2.01', }

=example-1 types

# given: synopsis

package main;

$unpack = $unpack->all->types('string | number | float');

# bless({...}, 'Venus::Unpack')

The use method selects the arguments specified (by index) for processing returns the invocant.

use(number @args) (Venus::Unpack)

{ since => '2.01', }

=example-1 use

# given: synopsis

package main;

$unpack = $unpack->use(1,2);

# bless(..., 'Venus::Unpack')

The validate method processes the selected arguments, passing each value to the "validate" in Venus::Assert method with the type expression provided and throws an exception on failure and otherise returns the resuts.

validate(string @types) (Venus::Unpack)

{ since => '2.01', }

=example-1 validate

# given: synopsis

package main;

my $results = $unpack->all->validate('string | number | float');

# ["hello", 123, 1.23]

t/Venus.t: present: authors t/Venus.t: present: license

cpanm Venus

perl -MCPAN -e shell
install Venus