Venus::Vars

Vars Class

Vars Class for Perl 5

method: default method: exists method: get method: name method: set method: unnamed

package main;

use Venus::Vars;

my $vars = Venus::Vars->new(
  value => { USER => 'awncorp', HOME => '/home/awncorp', },
  named => { iam => 'USER', root => 'HOME', },
);

# $vars->root; # $ENV{HOME}
# $vars->home; # $ENV{HOME}
# $vars->get('home'); # $ENV{HOME}
# $vars->get('HOME'); # $ENV{HOME}

# $vars->iam; # $ENV{USER}
# $vars->user; # $ENV{USER}
# $vars->get('user'); # $ENV{USER}
# $vars->get('USER'); # $ENV{USER}

This package provides methods for accessing %ENV items.

Venus::Kind::Utility

Venus::Role::Accessible Venus::Role::Buildable Venus::Role::Proxyable Venus::Role::Valuable

named: rw, opt, HashRef, {}

The default method returns the default value, i.e. {%ENV}.

default() (HashRef)

{ since => '0.01', }

=example-1 default

# given: synopsis;

my $default = $vars->default;

# { USER => 'awncorp', HOME => '/home/awncorp', ... }

The exists method takes a name or index and returns truthy if an associated value exists.

exists(Str $key) (Bool)

{ since => '0.01', }

=example-1 exists

# given: synopsis;

my $exists = $vars->exists('iam');;

# 1

The get method takes a name or index and returns the associated value.

get(Str $key) (Any)

{ since => '0.01', }

=example-1 get

# given: synopsis;

my $get = $vars->get('iam');

# "awncorp"

The name method takes a name or index and returns index if the the associated value exists.

name(Str $key) (Str | Undef)

{ since => '0.01', }

=example-1 name

# given: synopsis;

my $name = $vars->name('iam');

# "USER"

The set method takes a name or index and sets the value provided if the associated argument exists.

set(Str $key, Any $value) (Any)

{ since => '0.01', }

=example-1 set

# given: synopsis;

my $set = $vars->set('iam', 'root');

# "root"

The unnamed method returns an arrayref of values which have not been named using the named attribute.

unnamed() (HashRef)

{ since => '0.01', }

=example-1 unnamed

package main;

use Venus::Vars;

my $vars = Venus::Vars->new(
  value => { USER => 'awncorp', HOME => '/home/awncorp', },
  named => { root => 'HOME', },
);

my $unnamed = $vars->unnamed;

# { USER => "awncorp" }

t/Venus.t: pdml: authors t/Venus.t: pdml: license

cpanm Venus

perl -MCPAN -e shell
install Venus