NAME

Venus - Standard Library

ABSTRACT

Standard Library for Perl 5

VERSION

5.01

SYNOPSIS

  package main;
  use Venus 'catch', 'error', 'raise';
  # error handling
  my ($error, $result) = catch {
    error;
  };
  # boolean keywords
  if ($result) {
    error;
  }
  # raise exceptions
  if ($result) {
    raise 'MyApp::Error';
  }
  # boolean keywords, and more!
  my $bool = true ne false;

DESCRIPTION

This library provides an object-orientation framework and extendible standard library for Perl 5 with classes which wrap most native Perl data types. Venus has a simple modular architecture, robust library of classes, methods, and roles, supports pure-Perl autoboxing, advanced exception handling, "true" and "false" functions, package introspection, command-line options parsing, and more. This package will always automatically exports "true" and "false" keyword functions (unless existing routines of the same name already exist in the calling package or its parents), otherwise exports keyword functions as requested at import. This library requires Perl "5.18+".

CAPABILITIES

The following is a short list of capabilities:

Perl 5.18.0+
Zero Dependencies
Fast Object-Orientation
Robust Standard Library
Intuitive Value Classes
Pure Perl Autoboxing
Convenient Utility Classes
Simple Package Reflection
Flexible Exception Handling
Composable Standards
Pluggable (no monkeypatching)
Proxyable Methods
Type Assertions
Type Coercions
Value Casting
Boolean Values
Complete Documentation
Complete Test Coverage

FUNCTIONS

This package provides the following functions:

after

  after(string $name, coderef $code) (coderef)

The after function installs a method modifier that executes after the original method, allowing you to perform actions after a method call. Note: The return value of the modifier routine is ignored; the wrapped method always returns the value from the original method. Modifiers are executed in the order they are stacked. This function is always exported unless a routine of the same name already exists.

Since 4.15

after example 1

  package Example;
  use Venus::Class 'after', 'attr';
  attr 'calls';
  sub BUILD {
    my ($self) = @_;
    $self->calls([]);
  }
  sub test {
    my ($self) = @_;
    push @{$self->calls}, 'original';
    return 'original';
  }
  after 'test', sub {
    my ($self) = @_;
    push @{$self->calls}, 'after';
    return 'ignored';
  };
  package main;
  my $example = Example->new;
  my $value = $example->test;
  # "original"

after example 2

  package Example2;
  use Venus::Class 'after', 'attr';
  attr 'calls';
  sub BUILD {
    my ($self) = @_;
    $self->calls([]);
  }
  sub test {
    my ($self) = @_;
    push @{$self->calls}, 'original';
    return $self;
  }
  after 'test', sub {
    my ($self) = @_;
    push @{$self->calls}, 'after';
    return $self;
  };
  package main;
  my $example = Example2->new;
  $example->test;
  my $calls = $example->calls;
  # ['original', 'after']

all

  all(arrayref | hashref | consumes[Venus::Role::Mappable] $lvalue, any $rvalue) (boolean)

The all function accepts an arrayref, hashref, or "mappable" and returns true if the rvalue is a callback and returns true for all items in the collection. If the rvalue provided is not a coderef that value's type and value will be used as the criteria.

Since 4.15

all example 1

  # given: synopsis
  package main;
  use Venus 'all';
  my $all = all [1, '1'], 1;
  # false

all example 2

  # given: synopsis
  package main;
  use Venus 'all';
  my $all = all [1, 1], 1;
  # true

all example 3

  # given: synopsis
  package main;
  use Venus 'all';
  my $all = all {1, 2}, 1;
  # false

all example 4

  # given: synopsis
  package main;
  use Venus 'all';
  my $all = all {1, 1}, 1;
  # true

all example 5

  # given: synopsis
  package main;
  use Venus 'all';
  my $all = all [[1], [1]], [1];
  # true

all example 6

  # given: synopsis
  package main;
  use Venus 'all';
  my $all = all [1, '1', 2..4], sub{$_ > 0};
  # true

all example 7

  # given: synopsis
  package main;
  use Venus 'all';
  my $all = all [1, '1', 2..4], sub{$_ > 1};
  # false

any

  any(arrayref | hashref | consumes[Venus::Role::Mappable] $lvalue, any $rvalue) (boolean)

The any function accepts an arrayref, hashref, or "mappable" and returns true if the rvalue is a callback and returns true for any items in the collection. If the rvalue provided is not a coderef that value's type and value will be used as the criteria.

Since 4.15

any example 1

  # given: synopsis
  package main;
  use Venus 'any';
  my $any = any [1, '1'], 1;
  # true

any example 2

  # given: synopsis
  package main;
  use Venus 'any';
  my $any = any [1, 1], 0;
  # false

any example 3

  # given: synopsis
  package main;
  use Venus 'any';
  my $any = any {1, 2}, 1;
  # false

any example 4

  # given: synopsis
  package main;
  use Venus 'any';
  my $any = any {1, 1}, 1;
  # true

any example 5

  # given: synopsis
  package main;
  use Venus 'any';
  my $any = any [[0], [1]], [1];
  # true

any example 6

  # given: synopsis
  package main;
  use Venus 'any';
  my $any = any [1, '1', 2..4], sub{!defined};
  # false

any example 7

  # given: synopsis
  package main;
  use Venus 'any';
  my $any = any [1, '1', 2..4, undef], sub{!defined};
  # true

args

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

The args function builds and returns a Venus::Args object, or dispatches to the coderef or method provided.

Since 3.10

args example 1

  package main;
  use Venus 'args';
  my $args = args ['--resource', 'users'];
  # bless({...}, 'Venus::Args')

args example 2

  package main;
  use Venus 'args';
  my $args = args ['--resource', 'users'], 'indexed';
  # {0 => '--resource', 1 => 'users'}

around

  around(string $name, coderef $code) (coderef)

The around function installs a method modifier that wraps around the original method, giving you complete control over its execution. The modifier receives the original method as its first argument, followed by the method's arguments, and must explicitly call the original method if desired.

Since 4.15

around example 1

  package Example3;
  use Venus::Class 'around', 'attr';
  sub test {
    my ($self, $value) = @_;
    return $value;
  }
  around 'test', sub {
    my ($orig, $self, $value) = @_;
    my $result = $self->$orig($value);
    return $result * 2;
  };
  package main;
  my $result = Example3->new->test(5);
  # 10

around example 2

  package Example4;
  use Venus::Class 'around', 'attr';
  attr 'calls';
  sub BUILD {
    my ($self) = @_;
    $self->calls([]);
  }
  sub test {
    my ($self) = @_;
    push @{$self->calls}, 'original';
    return $self;
  }
  around 'test', sub {
    my ($orig, $self) = @_;
    push @{$self->calls}, 'before';
    $self->$orig;
    push @{$self->calls}, 'after';
    return $self;
  };
  package main;
  my $example = Example4->new;
  $example->test;
  my $calls = $example->calls;
  # ['before', 'original', 'after']

array

  array(arrayref | hashref $value, string | coderef $code, any @args) (any)

The array function builds and returns a Venus::Array object, or dispatches to the coderef or method provided.

Since 2.55

array example 1

  package main;
  use Venus 'array';
  my $array = array [];
  # bless({...}, 'Venus::Array')

array example 2

  package main;
  use Venus 'array';
  my $array = array [1..4], 'push', 5..9;
  # [1..9]

arrayref

  arrayref(any @args) (arrayref)

The arrayref function takes a list of arguments and returns a arrayref.

Since 3.10

arrayref example 1

  package main;
  use Venus 'arrayref';
  my $arrayref = arrayref(content => 'example');
  # [content => "example"]

arrayref example 2

  package main;
  use Venus 'arrayref';
  my $arrayref = arrayref([content => 'example']);
  # [content => "example"]

arrayref example 3

  package main;
  use Venus 'arrayref';
  my $arrayref = arrayref('content');
  # ['content']

assert

  assert(any $data, string $expr) (any)

The assert function builds a Venus::Assert object and returns the result of a "validate" in Venus::Assert operation.

Since 2.40

assert example 1

  package main;
  use Venus 'assert';
  my $assert = assert(1234567890, 'number');
  # 1234567890

assert example 2

  package main;
  use Venus 'assert';
  my $assert = assert(1234567890, 'float');
  # Exception! (isa Venus::Check::Error)

assert example 3

  package main;
  use Venus 'assert';
  my $assert = assert(1234567890, 'number | float');
  # 1234567890

async

  async(coderef $code, any @args) (Venus::Future)

The async function accepts a callback and executes it asynchronously via "future" in Venus::Process. This function returns a Venus::Future object which can be fulfilled via "wait" in Venus::Future.

Since 3.40

async example 1

  package main;
  use Venus 'async';
  my $async = async sub{
    'done'
  };
  # bless({...}, 'Venus::Future')

atom

  atom(any $value) (Venus::Atom)

The atom function builds and returns a Venus::Atom object.

Since 3.55

atom example 1

  package main;
  use Venus 'atom';
  my $atom = atom 'super-admin';
  # bless({scope => sub{...}}, "Venus::Atom")
  # "$atom"
  # "super-admin"

await

  await(Venus::Future $future, number $timeout) (any)

The await function accepts a Venus::Future object and eventually returns a value (or values) for it. The value(s) returned are the return values or emissions from the asychronous callback executed with "async" which produced the process object.

Since 3.40

await example 1

  package main;
  use Venus 'async', 'await';
  my $process;
  my $async = async sub{
    return 'done';
  };
  my $await = await $async;
  # bless(..., "Venus::Future")

before

  before(string $name, coderef $code) (coderef)

The before function installs a method modifier that executes before the original method, allowing you to perform actions before a method call. Note: The return value of the modifier routine is ignored; the wrapped method always returns the value from the original method. Modifiers are executed in the order they are stacked. This function is always exported unless a routine of the same name already exists.

Since 4.15

before example 1

  package Example5;
  use Venus::Class 'attr', 'before';
  attr 'calls';
  sub BUILD {
    my ($self) = @_;
    $self->calls([]);
  }
  sub test {
    my ($self) = @_;
    push @{$self->calls}, 'original';
    return $self;
  }
  before 'test', sub {
    my ($self) = @_;
    push @{$self->calls}, 'before';
    return $self;
  };
  package main;
  my $example = Example5->new;
  $example->test;
  my $calls = $example->calls;
  # ['before', 'original']

before example 2

  package Example6;
  use Venus::Class 'attr', 'before';
  attr 'validated';
  sub test {
    my ($self, $value) = @_;
    return $value;
  }
  before 'test', sub {
    my ($self, $value) = @_;
    $self->validated(1) if $value > 0;
    return 'ignored';
  };
  package main;
  my $example = Example6->new;
  my $value = $example->test(5);
  # 5

bool

  bool(any $value) (Venus::Boolean)

The bool function builds and returns a Venus::Boolean object.

Since 2.55

bool example 1

  package main;
  use Venus 'bool';
  my $bool = bool;
  # bless({value => 0}, 'Venus::Boolean')

bool example 2

  package main;
  use Venus 'bool';
  my $bool = bool 1_000;
  # bless({value => 1}, 'Venus::Boolean')

box

  box(any $data) (Venus::Box)

The box function returns a Venus::Box object for the argument provided.

Since 2.32

box example 1

  package main;
  use Venus 'box';
  my $box = box({});
  # bless({value => bless({value => {}}, 'Venus::Hash')}, 'Venus::Box')

box example 2

  package main;
  use Venus 'box';
  my $box = box([]);
  # bless({value => bless({value => []}, 'Venus::Array')}, 'Venus::Box')

call

  call(string | object | coderef $data, any @args) (any)

The call function dispatches function and method calls to a package and returns the result.

Since 2.32

call example 1

  package main;
  use Venus 'call';
  require Digest::SHA;
  my $result = call(\'Digest::SHA', 'new');
  # bless(do{\(my $o = '...')}, 'digest::sha')

call example 2

  package main;
  use Venus 'call';
  require Digest::SHA;
  my $result = call('Digest::SHA', 'sha1_hex');
  # "da39a3ee5e6b4b0d3255bfef95601890afd80709"

call example 3

  package main;
  use Venus 'call';
  require Venus::Hash;
  my $result = call(sub{'Venus::Hash'->new(@_)}, {1..4});
  # bless({value => {1..4}}, 'Venus::Hash')

call example 4

  package main;
  use Venus 'call';
  require Venus::Box;
  my $result = call(Venus::Box->new(value => {}), 'merge', {1..4});
  # bless({value => bless({value => {1..4}}, 'Venus::Hash')}, 'Venus::Box')

cast

  cast(any $data, string $type) (object)

The cast function returns the argument provided as an object, promoting native Perl data types to data type objects. The optional second argument can be the name of the type for the object to cast to explicitly.

Since 1.40

cast example 1

  package main;
  use Venus 'cast';
  my $undef = cast;
  # bless({value => undef}, "Venus::Undef")

cast example 2

  package main;
  use Venus 'cast';
  my @booleans = map cast, true, false;
  # (bless({value => 1}, "Venus::Boolean"), bless({value => 0}, "Venus::Boolean"))

cast example 3

  package main;
  use Venus 'cast';
  my $example = cast bless({}, "Example");
  # bless({value => 1}, "Example")

cast example 4

  package main;
  use Venus 'cast';
  my $float = cast 1.23;
  # bless({value => "1.23"}, "Venus::Float")

catch

  catch(coderef $block) (Venus::Error, any)

The catch function executes the code block trapping errors and returning the caught exception in scalar context, and also returning the result as a second argument in list context.

Since 0.01

catch example 1

  package main;
  use Venus 'catch';
  my $error = catch {die};
  $error;
  # "Died at ..."

catch example 2

  package main;
  use Venus 'catch';
  my ($error, $result) = catch {error};
  $error;
  # bless({...}, 'Venus::Error')

catch example 3

  package main;
  use Venus 'catch';
  my ($error, $result) = catch {true};
  $result;
  # 1

caught

  caught(object $error, string | tuple[string, string] $identity, coderef $block) (any)

The caught function evaluates the exception object provided and validates its identity and name (if provided) then executes the code block provided returning the result of the callback. If no callback is provided this function returns the exception object on success and "undef" on failure.

Since 1.95

caught example 1

  package main;
  use Venus 'catch', 'caught', 'error';
  my $error = catch { error };
  my $result = caught $error, 'Venus::Error';
  # bless(..., 'Venus::Error')

caught example 2

  package main;
  use Venus 'catch', 'caught', 'raise';
  my $error = catch { raise 'Example::Error' };
  my $result = caught $error, 'Venus::Error';
  # bless(..., 'Venus::Error')

caught example 3

  package main;
  use Venus 'catch', 'caught', 'raise';
  my $error = catch { raise 'Example::Error' };
  my $result = caught $error, 'Example::Error';
  # bless(..., 'Venus::Error')

caught example 4

  package main;
  use Venus 'catch', 'caught', 'raise';
  my $error = catch { raise 'Example::Error', { name => 'on.test' } };
  my $result = caught $error, ['Example::Error', 'on.test'];
  # bless(..., 'Venus::Error')

caught example 5

  package main;
  use Venus 'catch', 'caught', 'raise';
  my $error = catch { raise 'Example::Error', { name => 'on.recv' } };
  my $result = caught $error, ['Example::Error', 'on.send'];
  # undef

caught example 6

  package main;
  use Venus 'catch', 'caught', 'error';
  my $error = catch { error };
  my $result = caught $error, ['Example::Error', 'on.send'];
  # undef

caught example 7

  package main;
  use Venus 'catch', 'caught', 'error';
  my $error = catch { error };
  my $result = caught $error, ['Example::Error'];
  # undef

caught example 8

  package main;
  use Venus 'catch', 'caught', 'error';
  my $error = catch { error };
  my $result = caught $error, 'Example::Error';
  # undef

caught example 9

  package main;
  use Venus 'catch', 'caught', 'error';
  my $error = catch { error { name => 'on.send' } };
  my $result = caught $error, ['Venus::Error', 'on.send'];
  # bless(..., 'Venus::Error')

caught example 10

  package main;
  use Venus 'catch', 'caught', 'error';
  my $error = catch { error { name => 'on.send.open' } };
  my $result = caught $error, ['Venus::Error', 'on.send'], sub {
    $error->stash('caught', true) if $error->is('on.send.open');
    return $error;
  };
  # bless(..., 'Venus::Error')

chain

  chain(string | object | coderef $self, string | within[arrayref, string] @args) (any)

The chain function chains function and method calls to a package (and return values) and returns the result.

Since 2.32

chain example 1

  package main;
  use Venus 'chain';
  my $result = chain('Venus::Path', ['new', 't'], 'exists');
  # 1

chain example 2

  package main;
  use Venus 'chain';
  my $result = chain('Venus::Path', ['new', 't'], ['test', 'd']);
  # 1

check

  check(any $data, string $expr) (boolean)

The check function builds a Venus::Assert object and returns the result of a "check" in Venus::Assert operation.

Since 2.40

check example 1

  package main;
  use Venus 'check';
  my $check = check(rand, 'float');
  # true

check example 2

  package main;
  use Venus 'check';
  my $check = check(rand, 'string');
  # false

clargs

  clargs(arrayref $args, arrayref $spec) (Venus::Args, Venus::Opts, Venus::Vars)

The clargs function accepts a single arrayref of Getopt::Long specs, or an arrayref of arguments followed by an arrayref of Getopt::Long specs, and returns a three element list of Venus::Args, Venus::Opts, and Venus::Vars objects. If only a single arrayref is provided, the arguments will be taken from @ARGV. If this function is called in scalar context only the Venus::Opts object will be returned.

Since 3.10

clargs example 1

  package main;
  use Venus 'clargs';
  my ($args, $opts, $vars) = clargs;
  # (
  #   bless(..., 'Venus::Args'),
  #   bless(..., 'Venus::Opts'),
  #   bless(..., 'Venus::Vars')
  # )

clargs example 2

  package main;
  use Venus 'clargs';
  my ($args, $opts, $vars) = clargs ['resource|r=s', 'help|h'];
  # (
  #   bless(..., 'Venus::Args'),
  #   bless(..., 'Venus::Opts'),
  #   bless(..., 'Venus::Vars')
  # )

clargs example 3

  package main;
  use Venus 'clargs';
  my ($args, $opts, $vars) = clargs ['--resource', 'help'],
    ['resource|r=s', 'help|h'];
  # (
  #   bless(..., 'Venus::Args'),
  #   bless(..., 'Venus::Opts'),
  #   bless(..., 'Venus::Vars')
  # )

clargs example 4

  package main;
  use Venus 'clargs';
  my ($args, $opts, $vars) = clargs ['--help', 'how-to'],
    ['resource|r=s', 'help|h'];
  # (
  #   bless(..., 'Venus::Args'),
  #   bless(..., 'Venus::Opts'),
  #   bless(..., 'Venus::Vars')
  # )

clargs example 5

  package main;
  use Venus 'clargs';
  my $opts = clargs ['--help', 'how-to'], ['resource|r=s', 'help|h'];
  # bless(..., 'Venus::Opts'),

cli

  cli(arrayref $args) (Venus::Cli)

The cli function builds and returns a Venus::Cli object.

Since 2.55

cli example 1

  package main;
  use Venus 'cli';
  my $cli = cli;
  # bless({...}, 'Venus::Cli')

cli example 2

  package main;
  use Venus 'cli';
  my $cli = cli 'mycli';
  # bless({...}, 'Venus::Cli')
  # $cli->boolean('option', 'help');
  # $cli->parse('--help');
  # $cli->option_value('help');
  # 1

clone

  clone(ref $value) (ref)

The clone function uses "dclone" in Storable to perform a deep clone of the reference provided and returns a copy.

Since 3.55

clone example 1

  package main;
  use Venus 'clone';
  my $orig = {1..4};
  my $clone = clone $orig;
  $orig->{3} = 5;
  my $result = $clone;
  # {1..4}

clone example 2

  package main;
  use Venus 'clone';
  my $orig = {1,2,3,{1..4}};
  my $clone = clone $orig;
  $orig->{3}->{3} = 5;
  my $result = $clone;
  # {1,2,3,{1..4}}

code

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

The code function builds and returns a Venus::Code object, or dispatches to the coderef or method provided.

Since 2.55

code example 1

  package main;
  use Venus 'code';
  my $code = code sub {};
  # bless({...}, 'Venus::Code')

code example 2

  package main;
  use Venus 'code';
  my $code = code sub {[1, @_]}, 'curry', 2,3,4;
  # sub {...}

collect

  collect(any $value, coderef $code) (any)

The collect function uses Venus::Collect to iterate over the value and selectively transform or filter the data. The function supports both list-like and hash-like data structures, handling key/value iteration when applicable.

Since 4.15

collect example 1

  package main;
  use Venus 'collect';
  my $collect = collect [];
  # []

collect example 2

  package main;
  use Venus 'collect';
  my $collect = collect [1..4], sub{$_%2==0?(@_):()};
  # [2,4]

collect example 3

  package main;
  use Venus 'collect';
  my $collect = collect {};
  # {}

collect example 4

  package main;
  use Venus 'collect';
  my $collect = collect {1..8}, sub{$_%6==0?(@_):()};
  # {5,6}

concat

  concat(any @args) (string)

The concat function stringifies and "joins" multiple values delimited by a single space and returns the resulting string.

Since 4.15

concat example 1

  # given: synopsis
  package main;
  use Venus 'concat';
  my $concat = concat;
  # ""

concat example 2

  # given: synopsis
  package main;
  use Venus 'concat';
  my $concat = concat 'hello';
  # "hello"

concat example 3

  # given: synopsis
  package main;
  use Venus 'concat';
  my $concat = concat 'hello', 'world';
  # "hello world"

concat example 4

  # given: synopsis
  package main;
  use Venus 'concat';
  my $concat = concat 'value is', [1,2];
  # "value is [1,2]"

concat example 5

  # given: synopsis
  package main;
  use Venus 'concat';
  my $concat = concat 'value is', [1,2], 'and', [3,4];
  # "value is [1,2] and [3,4]"

config

  config(hashref $value, string | coderef $code, any @args) (any)

The config function builds and returns a Venus::Config object, or dispatches to the coderef or method provided.

Since 2.55

config example 1

  package main;
  use Venus 'config';
  my $config = config {};
  # bless({...}, 'Venus::Config')

config example 2

  package main;
  use Venus 'config';
  my $config = config {}, 'read_perl', '{"data"=>1}';
  # bless({...}, 'Venus::Config')

cop

  cop(string | object | coderef $self, string $name) (coderef)

The cop function attempts to curry the given subroutine on the object or class and if successful returns a closure.

Since 2.32

cop example 1

  package main;
  use Venus 'cop';
  my $coderef = cop('Digest::SHA', 'sha1_hex');
  # sub { ... }

cop example 2

  package main;
  use Venus 'cop';
  require Digest::SHA;
  my $coderef = cop(Digest::SHA->new, 'digest');
  # sub { ... }

data

  data(any $value, string | coderef $code, any @args) (any)

The data function builds and returns a Venus::Data object, or dispatches to the coderef or method provided.

Since 4.15

data example 1

  package main;
  use Venus 'data';
  my $data = data {value => {name => 'Elliot'}};
  # bless({...}, 'Venus::Data')

data example 2

  package main;
  use Venus 'data';
  my $data = data {value => {name => 'Elliot'}}, 'valid';
  # 1

data example 3

  package main;
  use Venus 'data';
  my $data = data {value => {name => 'Elliot'}}, 'shorthand', ['name!' => 'string'];
  # bless({...}, 'Venus::Data')
  # $data->valid;
  # 1

data example 4

  package main;
  use Venus 'data';
  my $data = data {value => {name => undef}}, 'shorthand', ['name!' => 'string'];
  # bless({...}, 'Venus::Data')
  # $data->valid;
  # 0

date

  date(number $value, string | coderef $code, any @args) (any)

The date function builds and returns a Venus::Date object, or dispatches to the coderef or method provided.

Since 2.40

date example 1

  package main;
  use Venus 'date';
  my $date = date time, 'string';
  # '0000-00-00T00:00:00Z'

date example 2

  package main;
  use Venus 'date';
  my $date = date time, 'reset', 570672000;
  # bless({...}, 'Venus::Date')
  # $date->string;
  # '1988-02-01T00:00:00Z'

date example 3

  package main;
  use Venus 'date';
  my $date = date time;
  # bless({...}, 'Venus::Date')

enum

  enum(arrayref | hashref $value) (Venus::Enum)

The enum function builds and returns a Venus::Enum object.

Since 3.55

enum example 1

  package main;
  use Venus 'enum';
  my $themes = enum ['light', 'dark'];
  # bless({scope => sub{...}}, "Venus::Enum")
  # my $result = $themes->get('dark');
  # bless({scope => sub{...}}, "Venus::Enum")
  # "$result"
  # "dark"

enum example 2

  package main;
  use Venus 'enum';
  my $themes = enum {
    light => 'light_theme',
    dark => 'dark_theme',
  };
  # bless({scope => sub{...}}, "Venus::Enum")
  # my $result = $themes->get('dark');
  # bless({scope => sub{...}}, "Venus::Enum")
  # "$result"
  # "dark_theme"

error

  error(maybe[hashref] $args) (Venus::Error)

The error function throws a Venus::Error exception object using the exception object arguments provided.

Since 0.01

error example 1

  package main;
  use Venus 'error';
  my $error = error;
  # bless({...}, 'Venus::Error')

error example 2

  package main;
  use Venus 'error';
  my $error = error {
    message => 'Something failed!',
  };
  # bless({message => 'Something failed!', ...}, 'Venus::Error')

factory

  factory(hashref $value, string | coderef $code, any @args) (any)

The factory function builds and returns a Venus::Factory object, or dispatches to the coderef or method provided.

Since 4.15

factory example 1

  package main;
  use Venus 'factory';
  my $factory = factory {};
  # bless(..., 'Venus::Factory')

factory example 2

  package main;
  use Venus 'factory';
  my $path = factory {name => 'path', value => ['/tmp/log']}, 'class', 'Venus::Path';
  # bless(..., 'Venus::Factory')
  # $path->build;
  # bless({value => '/tmp/log'}, 'Venus::Path')

false

  false() (boolean)

The false function returns a falsy boolean value which is designed to be practically indistinguishable from the conventional numerical 0 value.

Since 0.01

false example 1

  package main;
  use Venus;
  my $false = false;
  # 0

false example 2

  package main;
  use Venus;
  my $true = !false;
  # 1

fault

  fault(string $args) (Venus::Fault)

The fault function throws a Venus::Fault exception object and represents a system failure, and isn't meant to be caught.

Since 1.80

fault example 1

  package main;
  use Venus 'fault';
  my $fault = fault;
  # bless({message => 'Exception!'}, 'Venus::Fault')

fault example 2

  package main;
  use Venus 'fault';
  my $fault = fault 'Something failed!';
  # bless({message => 'Something failed!'}, 'Venus::Fault')

flat

  flat(any @args) (any)

The flat function take a list of arguments and flattens them where possible and returns the list of flattened values. When a hashref is encountered, it will be flattened into key/value pairs. When an arrayref is encountered, it will be flattened into a list of items.

Since 4.15

flat example 1

  package main;
  use Venus 'flat';
  my @flat = flat 1, 2, 3;
  # (1, 2, 3)

flat example 2

  package main;
  use Venus 'flat';
  my @flat = flat 1, 2, 3, [1, 2, 3];
  # (1, 2, 3, 1, 2, 3)

flat example 3

  package main;
  use Venus 'flat';
  my @flat = flat 1, 2, 3, [1, 2, 3], {1, 2};
  # (1, 2, 3, 1, 2, 3, 1, 2)

float

  float(string $value, string | coderef $code, any @args) (any)

The float function builds and returns a Venus::Float object, or dispatches to the coderef or method provided.

Since 2.55

float example 1

  package main;
  use Venus 'float';
  my $float = float 1.23;
  # bless({...}, 'Venus::Float')

float example 2

  package main;
  use Venus 'float';
  my $float = float 1.23, 'int';
  # 1

future

  future(coderef $code) (Venus::Future)

The future function builds and returns a Venus::Future object.

Since 3.55

future example 1

  package main;
  use Venus 'future';
  my $future = future(sub{
    my ($resolve, $reject) = @_;
    return int(rand(2)) ? $resolve->result('pass') : $reject->result('fail');
  });
  # bless(..., "Venus::Future")
  # $future->is_pending;
  # false

gather

  gather(any $value, coderef $callback) (any)

The gather function builds a Venus::Gather object, passing it and the value provided to the callback provided, and returns the return value from "result" in Venus::Gather.

Since 2.50

gather example 1

  package main;
  use Venus 'gather';
  my $gather = gather ['a'..'d'];
  # bless({...}, 'Venus::Gather')
  # $gather->result;
  # undef

gather example 2

  package main;
  use Venus 'gather';
  my $gather = gather ['a'..'d'], sub {{
    a => 1,
    b => 2,
    c => 3,
  }};
  # [1..3]

gather example 3

  package main;
  use Venus 'gather';
  my $gather = gather ['e'..'h'], sub {{
    a => 1,
    b => 2,
    c => 3,
  }};
  # []

gather example 4

  package main;
  use Venus 'gather';
  my $gather = gather ['a'..'d'], sub {
    my ($case) = @_;
    $case->when(sub{lc($_) eq 'a'})->then('a -> A');
    $case->when(sub{lc($_) eq 'b'})->then('b -> B');
  };
  # ['a -> A', 'b -> B']

gather example 5

  package main;
  use Venus 'gather';
  my $gather = gather ['a'..'d'], sub {
    $_->when(sub{lc($_) eq 'a'})->then('a -> A');
    $_->when(sub{lc($_) eq 'b'})->then('b -> B');
  };
  # ['a -> A', 'b -> B']

gets

  gets(string @args) (arrayref)

The gets function select values from within the underlying data structure using "path" in Venus::Array or "path" in Venus::Hash, where each argument is a selector, returns all the values selected. Returns a list in list context.

Since 4.15

gets example 1

  package main;
  use Venus 'gets';
  my $data = {'foo' => {'bar' => 'baz'}, 'bar' => ['baz']};
  my $gets = gets $data, 'bar', 'foo.bar';
  # [['baz'], 'baz']

gets example 2

  package main;
  use Venus 'gets';
  my $data = {'foo' => {'bar' => 'baz'}, 'bar' => ['baz']};
  my ($bar, $foo_bar) = gets $data, 'bar', 'foo.bar';
  # (['baz'], 'baz')

gets example 3

  package main;
  use Venus 'gets';
  my $data = ['foo', {'bar' => 'baz'}, 'bar', ['baz']];
  my $gets = gets $data, '3', '1.bar';
  # [['baz'], 'baz']

gets example 4

  package main;
  use Venus 'gets';
  my $data = ['foo', {'bar' => 'baz'}, 'bar', ['baz']];
  my ($baz, $one_bar) = gets $data, '3', '1.bar';
  # (['baz'], 'baz')

handle

  handle(string $name, coderef $code) (coderef)

The handle function installs a method modifier that wraps a method similar to "around", but is the low-level implementation. The modifier receives the original method as its first argument (which may be undef if the method doesn't
exist), followed by the method's arguments. This is the foundation for the other method modifiers.

Since 4.15

handle example 1

  package Example7;
  use Venus::Class 'handle';
  sub test {
    my ($self, $value) = @_;
    return $value;
  }
  handle 'test', sub {
    my ($orig, $self, $value) = @_;
    return $orig ? $self->$orig($value * 2) : 0;
  };
  package main;
  my $result = Example7->new->test(5);
  # 10

handle example 2

  package Example8;
  use Venus::Class 'handle';
  handle 'missing', sub {
    my ($orig, $self) = @_;
    return 'method does not exist';
  };
  package main;
  my $result = Example8->new->missing;
  # "method does not exist"

hash

  hash(hashref $value, string | coderef $code, any @args) (any)

The hash function builds and returns a Venus::Hash object, or dispatches to the coderef or method provided.

Since 2.55

hash example 1

  package main;
  use Venus 'hash';
  my $hash = hash {1..4};
  # bless({...}, 'Venus::Hash')

hash example 2

  package main;
  use Venus 'hash';
  my $hash = hash {1..8}, 'pairs';
  # [[1, 2], [3, 4], [5, 6], [7, 8]]

hashref

  hashref(any @args) (hashref)

The hashref function takes a list of arguments and returns a hashref.

Since 3.10

hashref example 1

  package main;
  use Venus 'hashref';
  my $hashref = hashref(content => 'example');
  # {content => "example"}

hashref example 2

  package main;
  use Venus 'hashref';
  my $hashref = hashref({content => 'example'});
  # {content => "example"}

hashref example 3

  package main;
  use Venus 'hashref';
  my $hashref = hashref('content');
  # {content => undef}

hashref example 4

  package main;
  use Venus 'hashref';
  my $hashref = hashref('content', 'example', 'algorithm');
  # {content => "example", algorithm => undef}

hook

  hook(string $type, string $name, coderef $code) (coderef)

The hook function is a specialized method modifier helper that applies a modifier (after, around, before, or handle) to a lifecycle hook method. It automatically uppercases the hook name, making it convenient for modifying Venus lifecycle hooks like BUILD, BLESS, BUILDARGS, and AUDIT.

Since 4.15

hook example 1

  package Example9;
  use Venus::Class 'attr', 'hook';
  attr 'startup';
  sub BUILD {
    my ($self, $args) = @_;
    $self->startup('original');
  }
  hook 'after', 'build', sub {
    my ($self) = @_;
    $self->startup('modified');
  };
  package main;
  my $result = Example9->new->startup;
  # "modified"

hook example 2

  package Example10;
  use Venus::Class 'attr', 'hook';
  attr 'calls';
  sub BUILD {
    my ($self, $args) = @_;
    $self->calls([]) if !$self->calls;
    push @{$self->calls}, 'BUILD';
  }
  hook 'before', 'build', sub {
    my ($self) = @_;
    $self->calls([]) if !$self->calls;
    push @{$self->calls}, 'before';
  };
  package main;
  my $example = Example10->new;
  my $calls = $example->calls;
  # ['before', 'BUILD']

in

  in(arrayref | hashref | consumes[Venus::Role::Mappable] $lvalue, any $rvalue) (boolean)

The in function accepts an arrayref, hashref, or "mappable" and returns true if the type and value of the rvalue is the same for any items in the collection.

Since 4.15

in example 1

  # given: synopsis
  package main;
  use Venus 'in';
  my $in = in [1, '1'], 1;
  # true

in example 2

  # given: synopsis
  package main;
  use Venus 'in';
  my $in = in [1, 1], 0;
  # false

in example 3

  # given: synopsis
  package main;
  use Venus 'in';
  my $in = in {1, 2}, 1;
  # false

in example 4

  # given: synopsis
  package main;
  use Venus 'in';
  my $in = in {1, 1}, 1;
  # true

in example 5

  # given: synopsis
  package main;
  use Venus 'in';
  my $in = in [[0], [1]], [1];
  # true

is

  is(any $lvalue, any $rvalue) (boolean)

The is function returns true if the lvalue and rvalue are identical, i.e. refers to the same memory address, otherwise returns false.

Since 4.15

is example 1

  # given: synopsis
  package main;
  use Venus 'is';
  my $is = is 1, 1;
  # false

is example 2

  # given: synopsis
  package main;
  use Venus 'is', 'number';
  my $a = number 1;
  my $is = is $a, 1;
  # false

is example 3

  # given: synopsis
  package main;
  use Venus 'is', 'number';
  my $a = number 1;
  my $is = is $a, $a;
  # true

is example 4

  # given: synopsis
  package main;
  use Venus 'is', 'number';
  my $a = number 1;
  my $b = number 1;
  my $is = is $a, $b;
  # false

is_blessed

  is_blessed(any $data) (boolean)

The is_blessed function uses "check" to validate that the data provided is an object returns true, otherwise returns false.

Since 4.15

is_blessed example 1

  # given: synopsis
  package main;
  use Venus 'is_blessed';
  my $is_blessed = is_blessed bless {};
  # true

is_blessed example 2

  # given: synopsis
  package main;
  use Venus 'is_blessed';
  my $is_blessed = is_blessed {};
  # false

is_boolean

  is_boolean(any $data) (boolean)

The is_boolean function uses "check" to validate that the data provided is a boolean returns true, otherwise returns false.

Since 4.15

is_boolean example 1

  # given: synopsis
  package main;
  use Venus 'is_boolean';
  my $is_boolean = is_boolean true;
  # true

is_boolean example 2

  # given: synopsis
  package main;
  use Venus 'is_boolean';
  my $is_boolean = is_boolean 1;
  # false

is_coderef

  is_coderef(any $data) (boolean)

The is_coderef function uses "check" to validate that the data provided is a coderef returns true, otherwise returns false.

Since 4.15

is_coderef example 1

  # given: synopsis
  package main;
  use Venus 'is_coderef';
  my $is_coderef = is_coderef sub{};
  # true

is_coderef example 2

  # given: synopsis
  package main;
  use Venus 'is_coderef';
  my $is_coderef = is_coderef {};
  # false

is_dirhandle

  is_dirhandle(any $data) (boolean)

The is_dirhandle function uses "check" to validate that the data provided is a dirhandle returns true, otherwise returns false.

Since 4.15

is_dirhandle example 1

  # given: synopsis
  package main;
  use Venus 'is_dirhandle';
  opendir my $dh, 't';
  my $is_dirhandle = is_dirhandle $dh;
  # true

is_dirhandle example 2

  # given: synopsis
  package main;
  use Venus 'is_dirhandle';
  open my $fh, '<', 't/data/moon';
  my $is_dirhandle = is_dirhandle $fh;
  # false

is_enum

  is_enum(any $data, value @args) (boolean)

The is_enum function uses "check" to validate that the data provided is an enum returns true, otherwise returns false.

Since 4.15

is_enum example 1

  # given: synopsis
  package main;
  use Venus 'is_enum';
  my $is_enum = is_enum 'yes', 'yes', 'no'
  # true

is_enum example 2

  # given: synopsis
  package main;
  use Venus 'is_enum';
  my $is_enum = is_enum 'yes', 'Yes', 'No';
  # false

is_error

  is_error(any $data, string | coderef $code, any @args) (boolean)

The is_error function accepts a scalar value and returns true if the value is (or is derived from) Venus::Error. This function can dispatch method calls and execute callbacks, and returns true of the return value from the callback is truthy, and false otherwise.

Since 4.15

is_error example 1

  package main;
  use Venus 'is_error';
  my $is_error = is_error 0;
  # false

is_error example 2

  package main;
  use Venus 'is_error';
  my $is_error = is_error 1;
  # false

is_error example 3

  package main;
  use Venus 'catch', 'fault', 'is_error';
  my $fault = catch {fault};
  my $is_error = is_error $fault;
  # false

is_error example 4

  package main;
  use Venus 'catch', 'error', 'is_error';
  my $error = catch {error};
  my $is_error = is_error $error;
  # true

is_error example 5

  package main;
  use Venus 'catch', 'error', 'is_error';
  my $error = catch {error {verbose => true}};
  my $is_error = is_error $error, 'verbose';
  # true

is_error example 6

  package main;
  use Venus 'catch', 'error', 'is_error';
  my $error = catch {error {verbose => false}};
  my $is_error = is_error $error, 'verbose';
  # false

is_false

  is_false(any $data, string | coderef $code, any @args) (boolean)

The is_false function accepts a scalar value and returns true if the value is falsy. This function can dispatch method calls and execute callbacks.

Since 3.04

is_false example 1

  package main;
  use Venus 'is_false';
  my $is_false = is_false 0;
  # true

is_false example 2

  package main;
  use Venus 'is_false';
  my $is_false = is_false 1;
  # false

is_false example 3

  package main;
  use Venus 'array', 'is_false';
  my $array = array [];
  my $is_false = is_false $array;
  # false

is_false example 4

  package main;
  use Venus 'array', 'is_false';
  my $array = array [];
  my $is_false = is_false $array, 'count';
  # true

is_false example 5

  package main;
  use Venus 'array', 'is_false';
  my $array = array [1];
  my $is_false = is_false $array, 'count';
  # false

is_false example 6

  package main;
  use Venus 'is_false';
  my $array = undef;
  my $is_false = is_false $array, 'count';
  # true

is_fault

  is_fault(any $data) (boolean)

The is_fault function accepts a scalar value and returns true if the value is (or is derived from) Venus::Fault.

Since 4.15

is_fault example 1

  package main;
  use Venus 'is_fault';
  my $is_fault = is_fault 0;
  # false

is_fault example 2

  package main;
  use Venus 'is_fault';
  my $is_fault = is_fault 1;
  # false

is_fault example 3

  package main;
  use Venus 'catch', 'fault', 'is_fault';
  my $fault = catch {fault};
  my $is_fault = is_fault $fault;
  # true

is_fault example 4

  package main;
  use Venus 'catch', 'error', 'is_fault';
  my $error = catch {error};
  my $is_fault = is_fault $error;
  # false

is_filehandle

  is_filehandle(any $data) (boolean)

The is_filehandle function uses "check" to validate that the data provided is a filehandle returns true, otherwise returns false.

Since 4.15

is_filehandle example 1

  # given: synopsis
  package main;
  use Venus 'is_filehandle';
  open my $fh, '<', 't/data/moon';
  my $is_filehandle = is_filehandle $fh;
  # true

is_filehandle example 2

  # given: synopsis
  package main;
  use Venus 'is_filehandle';
  opendir my $dh, 't';
  my $is_filehandle = is_filehandle $dh;
  # false

is_float

  is_float(any $data) (boolean)

The is_float function uses "check" to validate that the data provided is a float returns true, otherwise returns false.

Since 4.15

is_float example 1

  # given: synopsis
  package main;
  use Venus 'is_float';
  my $is_float = is_float .123;
  # true

is_float example 2

  # given: synopsis
  package main;
  use Venus 'is_float';
  my $is_float = is_float 123;
  # false

is_glob

  is_glob(any $data) (boolean)

The is_glob function uses "check" to validate that the data provided is a glob returns true, otherwise returns false.

Since 4.15

is_glob example 1

  # given: synopsis
  package main;
  use Venus 'is_glob';
  my $is_glob = is_glob \*main;
  # true

is_glob example 2

  # given: synopsis
  package main;
  use Venus 'is_glob';
  my $is_glob = is_glob *::main;
  # false

is_hashref

  is_hashref(any $data) (boolean)

The is_hashref function uses "check" to validate that the data provided is a hashref returns true, otherwise returns false.

Since 4.15

is_hashref example 1

  # given: synopsis
  package main;
  use Venus 'is_hashref';
  my $is_hashref = is_hashref {};
  # true

is_hashref example 2

  # given: synopsis
  package main;
  use Venus 'is_hashref';
  my $is_hashref = is_hashref [];
  # false

is_number

  is_number(any $data) (boolean)

The is_number function uses "check" to validate that the data provided is a number returns true, otherwise returns false.

Since 4.15

is_number example 1

  # given: synopsis
  package main;
  use Venus 'is_number';
  my $is_number = is_number 0;
  # true

is_number example 2

  # given: synopsis
  package main;
  use Venus 'is_number';
  my $is_number = is_number '0';
  # false

is_object

  is_object(any $data) (boolean)

The is_object function uses "check" to validate that the data provided is an object returns true, otherwise returns false.

Since 4.15

is_object example 1

  # given: synopsis
  package main;
  use Venus 'is_object';
  my $is_object = is_object bless {};
  # true

is_object example 2

  # given: synopsis
  package main;
  use Venus 'is_object';
  my $is_object = is_object {};
  # false

is_package

  is_package(any $data) (boolean)

The is_package function uses "check" to validate that the data provided is a package returns true, otherwise returns false.

Since 4.15

is_package example 1

  # given: synopsis
  package main;
  use Venus 'is_package';
  my $is_package = is_package 'Venus';
  # true

is_package example 2

  # given: synopsis
  package main;
  use Venus 'is_package';
  my $is_package = is_package 'MyApp';
  # false

is_reference

  is_reference(any $data) (boolean)

The is_reference function uses "check" to validate that the data provided is a reference returns true, otherwise returns false.

Since 4.15

is_reference example 1

  # given: synopsis
  package main;
  use Venus 'is_reference';
  my $is_reference = is_reference \0;
  # true

is_reference example 2

  # given: synopsis
  package main;
  use Venus 'is_reference';
  my $is_reference = is_reference 0;
  # false

is_regexp

  is_regexp(any $data) (boolean)

The is_regexp function uses "check" to validate that the data provided is a regexp returns true, otherwise returns false.

Since 4.15

is_regexp example 1

  # given: synopsis
  package main;
  use Venus 'is_regexp';
  my $is_regexp = is_regexp qr/hello/;
  # true

is_regexp example 2

  # given: synopsis
  package main;
  use Venus 'is_regexp';
  my $is_regexp = is_regexp 'hello';
  # false

is_scalarref

  is_scalarref(any $data) (boolean)

The is_scalarref function uses "check" to validate that the data provided is a scalarref returns true, otherwise returns false.

Since 4.15

is_scalarref example 1

  # given: synopsis
  package main;
  use Venus 'is_scalarref';
  my $is_scalarref = is_scalarref \1;
  # true

is_scalarref example 2

  # given: synopsis
  package main;
  use Venus 'is_scalarref';
  my $is_scalarref = is_scalarref 1;
  # false

is_string

  is_string(any $data) (boolean)

The is_string function uses "check" to validate that the data provided is a string returns true, otherwise returns false.

Since 4.15

is_string example 1

  # given: synopsis
  package main;
  use Venus 'is_string';
  my $is_string = is_string '0';
  # true

is_string example 2

  # given: synopsis
  package main;
  use Venus 'is_string';
  my $is_string = is_string 0;
  # false

is_true

  is_true(any $data, string | coderef $code, any @args) (boolean)

The is_true function accepts a scalar value and returns true if the value is truthy. This function can dispatch method calls and execute callbacks.

Since 3.04

is_true example 1

  package main;
  use Venus 'is_true';
  my $is_true = is_true 1;
  # true

is_true example 2

  package main;
  use Venus 'is_true';
  my $is_true = is_true 0;
  # false

is_true example 3

  package main;
  use Venus 'array', 'is_true';
  my $array = array [];
  my $is_true = is_true $array;
  # true

is_true example 4

  package main;
  use Venus 'array', 'is_true';
  my $array = array [];
  my $is_true = is_true $array, 'count';
  # false

is_true example 5

  package main;
  use Venus 'array', 'is_true';
  my $array = array [1];
  my $is_true = is_true $array, 'count';
  # true

is_true example 6

  package main;
  use Venus 'is_true';
  my $array = undef;
  my $is_true = is_true $array, 'count';
  # false

is_undef

  is_undef(any $data) (boolean)

The is_undef function uses "check" to validate that the data provided is an undef returns true, otherwise returns false.

Since 4.15

is_undef example 1

  # given: synopsis
  package main;
  use Venus 'is_undef';
  my $is_undef = is_undef undef;
  # true

is_undef example 2

  # given: synopsis
  package main;
  use Venus 'is_undef';
  my $is_undef = is_undef '';
  # false

is_value

  is_value(any $data) (boolean)

The is_value function uses "check" to validate that the data provided is an value returns true, otherwise returns false.

Since 4.15

is_value example 1

  # given: synopsis
  package main;
  use Venus 'is_value';
  my $is_value = is_value 0;
  # true

is_value example 2

  # given: synopsis
  package main;
  use Venus 'is_value';
  my $is_value = is_value sub{};
  # false

is_yesno

  is_yesno(any $data) (boolean)

The is_yesno function uses "check" to validate that the data provided is a yesno returns true, otherwise returns false.

Since 4.15

is_yesno example 1

  # given: synopsis
  package main;
  use Venus 'is_yesno';
  my $is_yesno = is_yesno 0;
  # true

is_yesno example 2

  # given: synopsis
  package main;
  use Venus 'is_yesno';
  my $is_yesno = is_yesno undef;
  # false

json

  json(string $call, any $data) (any)

The json function builds a Venus::Json object and will either "decode" in Venus::Json or "encode" in Venus::Json based on the argument provided and returns the result.

Since 2.40

json example 1

  package main;
  use Venus 'json';
  my $decode = json 'decode', '{"codename":["Ready","Robot"],"stable":true}';
  # { codename => ["Ready", "Robot"], stable => 1 }

json example 2

  package main;
  use Venus 'json';
  my $encode = json 'encode', { codename => ["Ready", "Robot"], stable => true };
  # '{"codename":["Ready","Robot"],"stable":true}'

json example 3

  package main;
  use Venus 'json';
  my $json = json;
  # bless({...}, 'Venus::Json')

json example 4

  package main;
  use Venus 'json';
  my $json = json 'class', {data => "..."};
  # Exception! (isa Venus::Fault)

kvargs

  kvargs(any @args) (hashref)

The kvargs function takes a list of arguments and returns a hashref. If a single hashref is provided, it is returned as-is. Otherwise, the arguments are treated as key-value pairs. If an odd number of arguments is provided, the last key will have "undef" as its value.

Since 5.00

kvargs example 1

  package main;
  use Venus 'kvargs';
  my $kvargs = kvargs {name => 'Elliot'};
  # {name => 'Elliot'}

kvargs example 2

  package main;
  use Venus 'kvargs';
  my $kvargs = kvargs name => 'Elliot', role => 'hacker';
  # {name => 'Elliot', role => 'hacker'}

kvargs example 3

  package main;
  use Venus 'kvargs';
  my $kvargs = kvargs name => 'Elliot', 'role';
  # {name => 'Elliot', role => undef}

kvargs example 4

  package main;
  use Venus 'kvargs';
  my $kvargs = kvargs;
  # {}

list

  list(any @args) (any)

The list function accepts a list of values and flattens any arrayrefs, returning a list of scalars.

Since 3.04

list example 1

  package main;
  use Venus 'list';
  my @list = list 1..4;
  # (1..4)

list example 2

  package main;
  use Venus 'list';
  my @list = list [1..4];
  # (1..4)

list example 3

  package main;
  use Venus 'list';
  my @list = list [1..4], 5, [6..10];
  # (1..10)

load

  load(any $name) (Venus::Space)

The load function loads the package provided and returns a Venus::Space object.

Since 2.32

load example 1

  package main;
  use Venus 'load';
  my $space = load 'Venus::Scalar';
  # bless({value => 'Venus::Scalar'}, 'Venus::Space')

log

  log(any @args) (Venus::Log)

The log function prints the arguments provided to STDOUT, stringifying complex values, and returns a Venus::Log object. If the first argument is a log level name, e.g. "debug", "error", "fatal", "info", "trace", or "warn", it will be used when emitting the event. The desired log level is specified by the "VENUS_LOG_LEVEL" environment variable and defaults to "trace".

Since 2.40

log example 1

  package main;
  use Venus 'log';
  my $log = log;
  # bless({...}, 'Venus::Log')
  # log time, rand, 1..9;
  # 00000000 0.000000, 1..9

make

  make(string $package, any @args) (any)

The make function "calls" the "new" routine on the invocant and returns the result which should be a package string or an object.

Since 2.32

make example 1

  package main;
  use Venus 'make';
  my $made = make('Digest::SHA');
  # bless(do{\(my $o = '...')}, 'Digest::SHA')

make example 2

  package main;
  use Venus 'make';
  my $made = make('Digest', 'SHA');
  # bless(do{\(my $o = '...')}, 'Digest::SHA')

map

  map(hashref $value) (Venus::Map)

The map function returns a Venus::Map object for the hashref provided.

Since 4.15

map example 1

  package main;
  use Venus;
  my $map = Venus::map {1..4};
  # bless(..., 'Venus::Map')

map example 2

  package main;
  use Venus;
  my $map = Venus::map {1..4}, 'count';
  # 2

match

  match(any $value, coderef $callback) (any)

The match function builds a Venus::Match object, passing it and the value provided to the callback provided, and returns the return value from "result" in Venus::Match.

Since 2.50

match example 1

  package main;
  use Venus 'match';
  my $match = match 5;
  # bless({...}, 'Venus::Match')
  # $match->result;
  # undef

match example 2

  package main;
  use Venus 'match';
  my $match = match 5, sub {{
    1 => 'one',
    2 => 'two',
    5 => 'five',
  }};
  # 'five'

match example 3

  package main;
  use Venus 'match';
  my $match = match 5, sub {{
    1 => 'one',
    2 => 'two',
    3 => 'three',
  }};
  # undef

match example 4

  package main;
  use Venus 'match';
  my $match = match 5, sub {
    my ($case) = @_;
    $case->when(sub{$_ < 5})->then('< 5');
    $case->when(sub{$_ > 5})->then('> 5');
  };
  # undef

match example 5

  package main;
  use Venus 'match';
  my $match = match 6, sub {
    my ($case, $data) = @_;
    $case->when(sub{$_ < 5})->then("$data < 5");
    $case->when(sub{$_ > 5})->then("$data > 5");
  };
  # '6 > 5'

match example 6

  package main;
  use Venus 'match';
  my $match = match 4, sub {
    $_->when(sub{$_ < 5})->then("$_[1] < 5");
    $_->when(sub{$_ > 5})->then("$_[1] > 5");
  };
  # '4 < 5'

merge

  merge(any @args) (any)

The merge function returns a value which is a merger of all of the arguments provided. This function is an alias for "merge_join" given the principle of least surprise.

Since 2.32

merge example 1

  package main;
  use Venus 'merge';
  my $merged = merge({1..4}, {5, 6});
  # {1..6}

merge example 2

  package main;
  use Venus 'merge';
  my $merged = merge({1..4}, {5, 6}, {7, 8, 9, 0});
  # {1..9, 0}

merge_flat

  merge_flat(any @args) (any)

The merge_flat function merges two (or more) values and returns a new values based on the types of the inputs:

Note: This function appends hashref values to an arrayref when encountered.

When the "lvalue" is a "scalar" and the "rvalue" is a "scalar" we keep the "rvalue".
When the "lvalue" is a "scalar" and the "rvalue" is a "arrayref" we keep the "rvalue".
When the "lvalue" is a "scalar" and the "rvalue" is a "hashref" we keep the "rvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "scalar" we append the "rvalue" to the "lvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "arrayref" we append the items in "rvalue" to the "lvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "hashref" we append the values in "rvalue" to the "lvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "scalar" we keep the "rvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "arrayref" we keep the "rvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "hashref" we append the keys and values in "rvalue" to the "lvalue", overwriting existing keys where there's overlap.

Since 4.15

merge_flat example 1

  # given: synopsis
  package main;
  use Venus 'merge_flat';
  my $merge_flat = merge_flat;
  # undef

merge_flat example 2

  # given: synopsis
  package main;
  use Venus 'merge_flat';
  my $merge_flat = merge_flat 1;
  # 1

merge_flat example 3

  # given: synopsis
  package main;
  use Venus 'merge_flat';
  my $merge_flat = merge_flat 1, 2;
  # 2

merge_flat example 4

  # given: synopsis
  package main;
  use Venus 'merge_flat';
  my $merge_flat = merge_flat 1, [2, 3];
  # [2, 3]

merge_flat example 5

  # given: synopsis
  package main;
  use Venus 'merge_flat';
  my $merge_flat = merge_flat 1, {a => 1};
  # {a => 1}

merge_flat example 6

  # given: synopsis
  package main;
  use Venus 'merge_flat';
  my $merge_flat = merge_flat [1, 2], 3;
  # [1, 2, 3]

merge_flat example 7

  # given: synopsis
  package main;
  use Venus 'merge_flat';
  my $merge_flat = merge_flat [1, 2], {a => 3, b => 4};
  # [1, 2, 3, 4]

merge_flat example 8

  # given: synopsis
  package main;
  use Venus 'merge_flat';
  my $merge_flat = merge_flat(
    {
      a => 1,
      b => {x => 10},
      d => 0,
      g => [4],
    },
    {
      b => {y => 20},
      c => 3,
      e => [5],
      f => [6]
    },
    {
      b => {z => 456},
      c => {z => 123},
      d => 2,
      e => [6, 7],
      f => {7, 8},
      g => 5,
    },
  );
  # {
  #   a => 1,
  #   b => {
  #     x => 10,
  #     y => 20,
  #     z => 456
  #   },
  #   c => {z => 123},
  #   d => 2,
  #   e => [5, 6, 7],
  #   f => [6, 8],
  #   g => [4, 5],
  # }

merge_flat_mutate

  merge_flat_mutate(any @args) (any)

The merge_flat_mutate performs a merge operaiton in accordance with "merge_flat" except that it mutates the values being merged and returns the mutated value.

Since 4.15

merge_flat_mutate example 1

  # given: synopsis
  package main;
  use Venus 'merge_flat_mutate';
  my $merge_flat_mutate = merge_flat_mutate;
  # undef

merge_flat_mutate example 2

  # given: synopsis
  package main;
  use Venus 'merge_flat_mutate';
  my $merge_flat_mutate = merge_flat_mutate 1;
  # 1

merge_flat_mutate example 3

  # given: synopsis
  package main;
  use Venus 'merge_flat_mutate';
  $result = 1;
  my $merge_flat_mutate = merge_flat_mutate $result, 2;
  # 2
  $result;
  # 2

merge_flat_mutate example 4

  # given: synopsis
  package main;
  use Venus 'merge_flat_mutate';
  $result = 1;
  my $merge_flat_mutate = merge_flat_mutate $result, [2, 3];
  # [2, 3]
  $result;
  # [2, 3]

merge_flat_mutate example 5

  # given: synopsis
  package main;
  use Venus 'merge_flat_mutate';
  $result = 1;
  my $merge_flat_mutate = merge_flat_mutate $result, {a => 1};
  # {a => 1}
  $result;
  # {a => 1}

merge_flat_mutate example 6

  # given: synopsis
  package main;
  use Venus 'merge_flat_mutate';
  $result = [1, 2];
  my $merge_flat_mutate = merge_flat_mutate $result, 3;
  # [1, 2, 3]
  $result;
  # [1, 2, 3]

merge_flat_mutate example 7

  # given: synopsis
  package main;
  use Venus 'merge_flat_mutate';
  $result = [1, 2];
  my $merge_flat_mutate = merge_flat_mutate $result, {a => 3, b => 4};
  # [1, 2, 3, 4]
  $result;
  # [1, 2, 3, 4]

merge_join

  merge_join(any @args) (any)

The merge_join merges two (or more) values and returns a new values based on the types of the inputs:

Note: This function merges hashrefs with hashrefs, and appends arrayrefs with arrayrefs.

When the "lvalue" is a "scalar" and the "rvalue" is a "scalar" we keep the "rvalue".
When the "lvalue" is a "scalar" and the "rvalue" is a "arrayref" we keep the "rvalue".
When the "lvalue" is a "scalar" and the "rvalue" is a "hashref" we keep the "rvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "scalar" we append the "rvalue" to the "lvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "arrayref" we append the items in "rvalue" to the "lvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "hashref" we append the "rvalue" to the "lvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "scalar" we keep the "rvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "arrayref" we keep the "rvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "hashref" we append the keys and values in "rvalue" to the "lvalue", overwriting existing keys where there's overlap.

Since 4.15

merge_join example 1

  # given: synopsis
  package main;
  use Venus 'merge_join';
  my $merge_join = merge_join;
  # undef

merge_join example 2

  # given: synopsis
  package main;
  use Venus 'merge_join';
  my $merge_join = merge_join 1;
  # 1

merge_join example 3

  # given: synopsis
  package main;
  use Venus 'merge_join';
  my $merge_join = merge_join 1, 2;
  # 2

merge_join example 4

  # given: synopsis
  package main;
  use Venus 'merge_join';
  my $merge_join = merge_join 1, [2, 3];
  # [2, 3]

merge_join example 5

  # given: synopsis
  package main;
  use Venus 'merge_join';
  my $merge_join = merge_join [1, 2], 3;
  # [1, 2, 3]

merge_join example 6

  # given: synopsis
  package main;
  use Venus 'merge_join';
  my $merge_join = merge_join [1, 2], [3, 4];
  # [1, 2, 3, 4]

merge_join example 7

  # given: synopsis
  package main;
  use Venus 'merge_join';
  my $merge_join = merge_join {a => 1}, {a => 2, b => 3};
  # {a => 2, b => 3}

merge_join example 8

  # given: synopsis
  package main;
  use Venus 'merge_join';
  my $merge_join = merge_join(
    {
      a => 1,
      b => {x => 10},
      d => 0,
      g => [4],
    },
    {
      b => {y => 20},
      c => 3,
      e => [5],
      f => [6]
    },
    {
      b => {z => 456},
      c => {z => 123},
      d => 2,
      e => [6, 7],
      f => {7, 8},
      g => 5,
    },
  );
  # {
  #   a => 1,
  #   b => {
  #     x => 10,
  #     y => 20,
  #     z => 456
  #   },
  #   c => {z => 123},
  #   d => 2,
  #   e => [5, 6, 7],
  #   f => [6, {7, 8}],
  #   g => [4, 5],
  # }

merge_join_mutate

  merge_join_mutate(any @args) (any)

The merge_join_mutate performs a merge operaiton in accordance with "merge_join" except that it mutates the values being merged and returns the mutated value.

Since 4.15

merge_join_mutate example 1

  # given: synopsis
  package main;
  use Venus 'merge_join_mutate';
  my $merge_join_mutate = merge_join_mutate;
  # undef

merge_join_mutate example 2

  # given: synopsis
  package main;
  use Venus 'merge_join_mutate';
  my $merge_join_mutate = merge_join_mutate 1;
  # 1

merge_join_mutate example 3

  # given: synopsis
  package main;
  use Venus 'merge_join_mutate';
  $result = 1;
  my $merge_join_mutate = merge_join_mutate $result, 2;
  # 2
  $result;
  # 2

merge_join_mutate example 4

  # given: synopsis
  package main;
  use Venus 'merge_join_mutate';
  $result = 1;
  my $merge_join_mutate = merge_join_mutate $result, [2, 3];
  # [2, 3]
  $result;
  # [2, 3]

merge_join_mutate example 5

  # given: synopsis
  package main;
  use Venus 'merge_join_mutate';
  $result = [1, 2];
  my $merge_join_mutate = merge_join_mutate $result, 3;
  # [1, 2, 3]
  $result;
  # [1, 2, 3]

merge_join_mutate example 6

  # given: synopsis
  package main;
  use Venus 'merge_join_mutate';
  $result = [1, 2];
  my $merge_join_mutate = merge_join_mutate $result, [3, 4];
  # [1, 2, 3, 4]
  $result;
  # [1, 2, 3, 4]

merge_join_mutate example 7

  # given: synopsis
  package main;
  use Venus 'merge_join_mutate';
  $result = {a => 1};
  my $merge_join_mutate = merge_join_mutate $result, {a => 2, b => 3};
  # {a => 2, b => 3}
  $result;
  # {a => 2, b => 3}

merge_keep

  merge_keep(any @args) (any)

The merge_keep function merges two (or more) values and returns a new values based on the types of the inputs:

Note: This function retains the existing data, appends arrayrefs with arrayrefs, and only merges new keys and values when merging hashrefs with hashrefs.

When the "lvalue" is a "scalar" and the "rvalue" is a "scalar" we keep the "lvalue".
When the "lvalue" is a "scalar" and the "rvalue" is a "arrayref" we keep the "lvalue".
When the "lvalue" is a "scalar" and the "rvalue" is a "hashref" we keep the "lvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "scalar" we append the "rvalue" to the "lvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "arrayref" we append the items in "rvalue" to the "lvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "hashref" we append the "rvalue" to the "lvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "scalar" we keep the "lvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "arrayref" we keep the "lvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "hashref" we append the keys and values in "rvalue" to the "lvalue", but without overwriting existing keys if there's overlap.

Since 4.15

merge_keep example 1

  # given: synopsis
  package main;
  use Venus 'merge_keep';
  my $merge_keep = merge_keep;
  # undef

merge_keep example 2

  # given: synopsis
  package main;
  use Venus 'merge_keep';
  my $merge_keep = merge_keep 1;
  # 1

merge_keep example 3

  # given: synopsis
  package main;
  use Venus 'merge_keep';
  my $merge_keep = merge_keep 1, 2;
  # 1

merge_keep example 4

  # given: synopsis
  package main;
  use Venus 'merge_keep';
  my $merge_keep = merge_keep 1, [2, 3];
  # 1

merge_keep example 5

  # given: synopsis
  package main;
  use Venus 'merge_keep';
  my $merge_keep = merge_keep [1, 2], 3;
  # [1, 2, 3]

merge_keep example 6

  # given: synopsis
  package main;
  use Venus 'merge_keep';
  my $merge_keep = merge_keep [1, 2], [3, 4];
  # [1, 2, 3, 4]

merge_keep example 7

  # given: synopsis
  package main;
  use Venus 'merge_keep';
  my $merge_keep = merge_keep {a => 1}, {a => 2, b => 3};
  # {a => 1, b => 3}

merge_keep example 8

  # given: synopsis
  package main;
  use Venus 'merge_keep';
  my $merge_keep = merge_keep(
    {
      a => 1,
      b => {x => 10},
      d => 0,
      g => [4],
    },
    {
      b => {y => 20},
      c => 3,
      e => [5],
      f => [6]
    },
    {
      b => {y => 30, z => 456},
      c => {z => 123},
      d => 2,
      e => [6, 7],
      f => {7, 8},
      g => 5,
    },
  );
  # {
  #   a => 1,
  #   b => {
  #     x => 10,
  #     y => 20,
  #     z => 456
  #   },
  #   c => 3,
  #   d => 0,
  #   e => [5, 6, 7],
  #   f => [6, {7, 8}],
  #   g => [4, 5],
  # }

merge_keep_mutate

  merge_keep_mutate(any @args) (any)

The merge_keep_mutate performs a merge operaiton in accordance with "merge_keep" except that it mutates the values being merged and returns the mutated value.

Since 4.15

merge_keep_mutate example 1

  # given: synopsis
  package main;
  use Venus 'merge_keep_mutate';
  my $merge_keep_mutate = merge_keep_mutate;
  # undef

merge_keep_mutate example 2

  # given: synopsis
  package main;
  use Venus 'merge_keep_mutate';
  my $merge_keep_mutate = merge_keep_mutate 1;
  # 1

merge_keep_mutate example 3

  # given: synopsis
  package main;
  use Venus 'merge_keep_mutate';
  $result = 1;
  my $merge_keep_mutate = merge_keep_mutate $result, 2;
  # 1
  $result;
  # 1

merge_keep_mutate example 4

  # given: synopsis
  package main;
  use Venus 'merge_keep_mutate';
  $result = 1;
  my $merge_keep_mutate = merge_keep_mutate $result, [2, 3];
  # 1
  $result;
  # 1

merge_keep_mutate example 5

  # given: synopsis
  package main;
  use Venus 'merge_keep_mutate';
  $result = [1, 2];
  my $merge_keep_mutate = merge_keep_mutate $result, 3;
  # [1, 2, 3]
  $result;
  # [1, 2, 3]

merge_keep_mutate example 6

  # given: synopsis
  package main;
  use Venus 'merge_keep_mutate';
  $result = [1, 2];
  my $merge_keep_mutate = merge_keep_mutate $result, [3, 4];
  # [1, 2, 3, 4]
  $result;
  # [1, 2, 3, 4]

merge_keep_mutate example 7

  # given: synopsis
  package main;
  use Venus 'merge_keep_mutate';
  $result = {a => 1};
  my $merge_keep_mutate = merge_keep_mutate $result, {a => 2, b => 3};
  # {a => 1, b => 3}
  $result;
  # {a => 1, b => 3}

merge_swap

  merge_swap(any @args) (any)

The merge_swap function merges two (or more) values and returns a new values based on the types of the inputs:

Note: This function replaces the existing data, including when merging hashrefs with hashrefs, and overwrites values (instead of appending) when merging arrayrefs with arrayrefs.

When the "lvalue" is a "scalar" and the "rvalue" is a "scalar" we keep the "rvalue".
When the "lvalue" is a "scalar" and the "rvalue" is a "arrayref" we keep the "rvalue".
When the "lvalue" is a "scalar" and the "rvalue" is a "hashref" we keep the "rvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "scalar" we append the "rvalue" to the "lvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "arrayref" we replace each items in "lvalue" with the value at the corresponding position in the "rvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "hashref" we append the "rvalue" to the "lvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "scalar" we keep the "rvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "arrayref" we keep the "rvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "hashref" we append the keys and values in "rvalue" to the "lvalue", overwriting existing keys if there's overlap.

Since 4.15

merge_swap example 1

  # given: synopsis
  package main;
  use Venus 'merge_swap';
  my $merge_swap = merge_swap;
  # undef

merge_swap example 2

  # given: synopsis
  package main;
  use Venus 'merge_swap';
  my $merge_swap = merge_swap 1;
  # 1

merge_swap example 3

  # given: synopsis
  package main;
  use Venus 'merge_swap';
  my $merge_swap = merge_swap 1, 2;
  # 2

merge_swap example 4

  # given: synopsis
  package main;
  use Venus 'merge_swap';
  my $merge_swap = merge_swap 1, [2, 3];
  # [2, 3]

merge_swap example 5

  # given: synopsis
  package main;
  use Venus 'merge_swap';
  my $merge_swap = merge_swap [1, 2], 3;
  # [1, 2, 3]

merge_swap example 6

  # given: synopsis
  package main;
  use Venus 'merge_swap';
  my $merge_swap = merge_swap [1, 2, 3], [4, 5];
  # [4, 5, 3]

merge_swap example 7

  # given: synopsis
  package main;
  use Venus 'merge_swap';
  my $merge_swap = merge_swap {a => 1}, {a => 2, b => 3};
  # {a => 2, b => 3}

merge_swap example 8

  # given: synopsis
  package main;
  use Venus 'merge_swap';
  my $merge_swap = merge_swap(
    {
      a => 1,
      b => {x => 10},
      d => 0,
      g => [4],
    },
    {
      b => {y => 20},
      c => 3,
      e => [5],
      f => [6]
    },
    {
      b => {y => 30, z => 456},
      c => {z => 123},
      d => 2,
      e => [6, 7],
      f => {7, 8},
      g => 5,
    },
  );
  # {
  #   a => 1,
  #   b => {
  #     x => 10,
  #     y => 30,
  #     z => 456
  #   },
  #   c => {z => 123},
  #   d => 2,
  #   e => [6, 7],
  #   f => [6, {7, 8}],
  #   g => [4, 5],
  # }

merge_swap_mutate

  merge_swap_mutate(any @args) (any)

The merge_swap_mutate performs a merge operaiton in accordance with "merge_swap" except that it mutates the values being merged and returns the mutated value.

Since 4.15

merge_swap_mutate example 1

  # given: synopsis
  package main;
  use Venus 'merge_swap_mutate';
  $result = undef;
  my $merge_swap_mutate = merge_swap_mutate $result;
  # undef
  $result;
  # undef

merge_swap_mutate example 2

  # given: synopsis
  package main;
  use Venus 'merge_swap_mutate';
  $result = 1;
  my $merge_swap_mutate = merge_swap_mutate $result;
  # 1
  $result;
  # 1

merge_swap_mutate example 3

  # given: synopsis
  package main;
  use Venus 'merge_swap_mutate';
  $result = 1;
  my $merge_swap_mutate = merge_swap_mutate $result, 2;
  # 2
  $result;
  # 2

merge_swap_mutate example 4

  # given: synopsis
  package main;
  use Venus 'merge_swap_mutate';
  $result = 1;
  my $merge_swap_mutate = merge_swap_mutate $result, [2, 3];
  # [2, 3]
  $result;
  # [2, 3]

merge_swap_mutate example 5

  # given: synopsis
  package main;
  use Venus 'merge_swap_mutate';
  $result = [1, 2];
  my $merge_swap_mutate = merge_swap_mutate $result, 3;
  # [1, 2, 3]
  $result;
  # [1, 2, 3]

merge_swap_mutate example 6

  # given: synopsis
  package main;
  use Venus 'merge_swap_mutate';
  $result = [1, 2, 3];
  my $merge_swap_mutate = merge_swap_mutate $result, [4, 5];
  # [4, 5, 3]
  $result;
  # [4, 5, 3]

merge_swap_mutate example 7

  # given: synopsis
  package main;
  use Venus 'merge_swap_mutate';
  $result = {a => 1};
  my $merge_swap_mutate = merge_swap_mutate $result, {a => 2, b => 3};
  # {a => 2, b => 3}
  $result;
  # {a => 2, b => 3}

merge_take

  merge_take(any @args) (any)

The merge_take function merges two (or more) values and returns a new values based on the types of the inputs:

Note: This function always "takes" the new value, does not append arrayrefs, and overwrites keys and values when merging hashrefs with hashrefs.

When the "lvalue" is a "scalar" and the "rvalue" is a "scalar" we keep the "rvalue".
When the "lvalue" is a "scalar" and the "rvalue" is a "arrayref" we keep the "rvalue".
When the "lvalue" is a "scalar" and the "rvalue" is a "hashref" we keep the "rvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "scalar" we keep the "rvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "arrayref" we keep the "rvalue".
When the "lvalue" is a "arrayref" and the "rvalue" is a "hashref" we keep the "rvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "scalar" we keep the "rvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "arrayref" we keep the "rvalue".
When the "lvalue" is a "hashref" and the "rvalue" is a "hashref" we append the keys and values in "rvalue" to the "lvalue", overwriting existing keys if there's overlap.

Since 4.15

merge_take example 1

  # given: synopsis
  package main;
  use Venus 'merge_take';
  my $merge_take = merge_take;
  # undef

merge_take example 2

  # given: synopsis
  package main;
  use Venus 'merge_take';
  my $merge_take = merge_take 1;
  # 1

merge_take example 3

  # given: synopsis
  package main;
  use Venus 'merge_take';
  my $merge_take = merge_take 1, 2;
  # 2

merge_take example 4

  # given: synopsis
  package main;
  use Venus 'merge_take';
  my $merge_take = merge_take [1], [2, 3];
  # [2, 3]

merge_take example 5

  # given: synopsis
  package main;
  use Venus 'merge_take';
  my $merge_take = merge_take {a => 1, b => {x => 10}}, {b => {y => 20}, c => 3};
  # {a => 1, b => {x => 10, y => 20}, c => 3}

merge_take example 6

  # given: synopsis
  package main;
  use Venus 'merge_take';
  my $merge_take = merge_take [1, 2], 3;
  # 3

merge_take example 7

  # given: synopsis
  package main;
  use Venus 'merge_take';
  my $merge_take = merge_take {a => 1}, 2;
  # 2

merge_take example 8

  # given: synopsis
  package main;
  use Venus 'merge_take';
  my $merge_take = merge_take(
    {
      a => 1,
      b => {x => 10},
      d => 0,
      g => [4],
    },
    {
      b => {y => 20},
      c => 3,
      e => [5],
      f => [6]
    },
    {
      b => {y => 30, z => 456},
      c => {z => 123},
      d => 2,
      e => [6, 7],
      f => {7, 8},
      g => 5,
    },
  );
  # {
  #   a => 1,
  #   b => {
  #     x => 10,
  #     y => 30,
  #     z => 456
  #   },
  #   c => {z => 123},
  #   d => 2,
  #   e => [6, 7],
  #   f => {7, 8},
  #   g => 5,
  # }

merge_take_mutate

  merge_take_mutate(any @args) (any)

The merge_take_mutate performs a merge operaiton in accordance with "merge_take" except that it mutates the values being merged and returns the mutated value.

Since 4.15

merge_take_mutate example 1

  # given: synopsis
  package main;
  use Venus 'merge_take_mutate';
  $result = undef;
  my $merge_take_mutate = merge_take_mutate $result;
  # undef
  $result;
  # undef

merge_take_mutate example 2

  # given: synopsis
  package main;
  use Venus 'merge_take_mutate';
  $result = 1;
  my $merge_take_mutate = merge_take_mutate $result;
  # 1
  $result;
  # 1

merge_take_mutate example 3

  # given: synopsis
  package main;
  use Venus 'merge_take_mutate';
  $result = 1;
  my $merge_take_mutate = merge_take_mutate $result, 2;
  # 2
  $result;
  # 2

merge_take_mutate example 4

  # given: synopsis
  package main;
  use Venus 'merge_take_mutate';
  $result = [1];
  my $merge_take_mutate = merge_take_mutate $result, [2, 3];
  # [2, 3]
  $result;
  # [2, 3]

merge_take_mutate example 5

  # given: synopsis
  package main;
  use Venus 'merge_take_mutate';
  $result = {a => 1, b => {x => 10}};
  my $merge_take_mutate = merge_take_mutate $result, {b => {y => 20}, c => 3};
  # {a => 1, b => {x => 10, y => 20}, c => 3}
  $result;
  # {a => 1, b => {x => 10, y => 20}, c => 3}

merge_take_mutate example 6

  # given: synopsis
  package main;
  use Venus 'merge_take_mutate';
  $result = [1, 2];
  my $merge_take_mutate = merge_take_mutate $result, 3;
  # 3
  $result;
  # 3

merge_take_mutate example 7

  # given: synopsis
  package main;
  use Venus 'merge_take_mutate';
  $result = {a => 1};
  my $merge_take_mutate = merge_take_mutate $result, 2;
  # 2
  $result;
  # 2

name

  name(string $value, string | coderef $code, any @args) (any)

The name function builds and returns a Venus::Name object, or dispatches to the coderef or method provided.

Since 2.55

name example 1

  package main;
  use Venus 'name';
  my $name = name 'Foo/Bar';
  # bless({...}, 'Venus::Name')

name example 2

  package main;
  use Venus 'name';
  my $name = name 'Foo/Bar', 'package';
  # "Foo::Bar"

number

  number(Num $value, string | coderef $code, any @args) (any)

The number function builds and returns a Venus::Number object, or dispatches to the coderef or method provided.

Since 2.55

number example 1

  package main;
  use Venus 'number';
  my $number = number 1_000;
  # bless({...}, 'Venus::Number')

number example 2

  package main;
  use Venus 'number';
  my $number = number 1_000, 'prepend', 1;
  # 11_000

opts

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

The opts function builds and returns a Venus::Opts object, or dispatches to the coderef or method provided.

Since 2.55

opts example 1

  package main;
  use Venus 'opts';
  my $opts = opts ['--resource', 'users'];
  # bless({...}, 'Venus::Opts')

opts example 2

  package main;
  use Venus 'opts';
  my $opts = opts ['--resource', 'users'], 'reparse', ['resource|r=s', 'help|h'];
  # bless({...}, 'Venus::Opts')
  # my $resource = $opts->get('resource');
  # "users"

pairs

  pairs(any $data) (arrayref)

The pairs function accepts an arrayref or hashref and returns an arrayref of arrayrefs holding keys (or indices) and values. The function returns an empty arrayref for all other values provided. Returns a list in list context.

Since 3.04

pairs example 1

  package main;
  use Venus 'pairs';
  my $pairs = pairs [1..4];
  # [[0,1], [1,2], [2,3], [3,4]]

pairs example 2

  package main;
  use Venus 'pairs';
  my $pairs = pairs {'a' => 1, 'b' => 2, 'c' => 3, 'd' => 4};
  # [['a',1], ['b',2], ['c',3], ['d',4]]

pairs example 3

  package main;
  use Venus 'pairs';
  my @pairs = pairs [1..4];
  # ([0,1], [1,2], [2,3], [3,4])

pairs example 4

  package main;
  use Venus 'pairs';
  my @pairs = pairs {'a' => 1, 'b' => 2, 'c' => 3, 'd' => 4};
  # (['a',1], ['b',2], ['c',3], ['d',4])

path

  path(string $value, string | coderef $code, any @args) (any)

The path function builds and returns a Venus::Path object, or dispatches to the coderef or method provided.

Since 2.55

path example 1

  package main;
  use Venus 'path';
  my $path = path 't/data/planets';
  # bless({...}, 'Venus::Path')

path example 2

  package main;
  use Venus 'path';
  my $path = path 't/data/planets', 'absolute';
  # bless({...}, 'Venus::Path')

perl

  perl(string $call, any $data) (any)

The perl function builds a Venus::Dump object and will either "decode" in Venus::Dump or "encode" in Venus::Dump based on the argument provided and returns the result.

Since 2.40

perl example 1

  package main;
  use Venus 'perl';
  my $decode = perl 'decode', '{stable=>bless({},\'Venus::True\')}';
  # { stable => 1 }

perl example 2

  package main;
  use Venus 'perl';
  my $encode = perl 'encode', { stable => true };
  # '{stable=>bless({},\'Venus::True\')}'

perl example 3

  package main;
  use Venus 'perl';
  my $perl = perl;
  # bless({...}, 'Venus::Dump')

perl example 4

  package main;
  use Venus 'perl';
  my $perl = perl 'class', {data => "..."};
  # Exception! (isa Venus::Fault)

process

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

The process function builds and returns a Venus::Process object, or dispatches to the coderef or method provided.

Since 2.55

process example 1

  package main;
  use Venus 'process';
  my $process = process;
  # bless({...}, 'Venus::Process')

process example 2

  package main;
  use Venus 'process';
  my $process = process 'do', 'alarm', 10;
  # bless({...}, 'Venus::Process')

proto

  proto(hashref $value, string | coderef $code, any @args) (any)

The proto function builds and returns a Venus::Prototype object, or dispatches to the coderef or method provided.

Since 2.55

proto example 1

  package main;
  use Venus 'proto';
  my $proto = proto {
    '$counter' => 0,
  };
  # bless({...}, 'Venus::Prototype')

proto example 2

  package main;
  use Venus 'proto';
  my $proto = proto { '$counter' => 0 }, 'apply', {
    '&decrement' => sub { $_[0]->counter($_[0]->counter - 1) },
    '&increment' => sub { $_[0]->counter($_[0]->counter + 1) },
  };
  # bless({...}, 'Venus::Prototype')

puts

  puts(any @args) (arrayref)

The puts function select values from within the underlying data structure using "path" in Venus::Array or "path" in Venus::Hash, optionally assigning the value to the preceeding scalar reference and returns all the values selected.

Since 3.20

puts example 1

  package main;
  use Venus 'puts';
  my $data = {
    size => "small",
    fruit => "apple",
    meta => {
      expiry => '5d',
    },
    color => "red",
  };
  puts $data, (
    \my $fruit, 'fruit',
    \my $expiry, 'meta.expiry'
  );
  my $puts = [$fruit, $expiry];
  # ["apple", "5d"]

raise

  raise(string $class | tuple[string, string] $class, any @args) (Venus::Error)

The raise function generates and throws a named exception object derived from Venus::Error, or provided base class, using the exception object arguments provided.

Since 0.01

raise example 1

  package main;
  use Venus 'raise';
  my $error = raise 'MyApp::Error';
  # bless({...}, 'MyApp::Error')

raise example 2

  package main;
  use Venus 'raise';
  my $error = raise ['MyApp::Error', 'Venus::Error'];
  # bless({...}, 'MyApp::Error')

raise example 3

  package main;
  use Venus 'raise';
  my $error = raise ['MyApp::Error', 'Venus::Error'], {
    message => 'Something failed!',
  };
  # bless({message => 'Something failed!', ...}, 'MyApp::Error')

raise example 4

  package main;
  use Venus 'raise';
  my $error = raise 'MyApp::Error', message => 'Something failed!';
  # bless({message => 'Something failed!', ...}, 'MyApp::Error')

raise example 5

  package main;
  use Venus 'raise';
  my $error = raise 'MyApp::Error', name => 'on.issue',  message => 'Something failed!';
  # bless({message => 'Something failed!', ...}, 'MyApp::Error')

random

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

The random function builds and returns a Venus::Random object, or dispatches to the coderef or method provided.

Since 2.55

random example 1

  package main;
  use Venus 'random';
  my $random = random;
  # bless({...}, 'Venus::Random')

random example 2

  package main;
  use Venus 'random';
  my $random = random 'collect', 10, 'letter';
  # "ryKUPbJHYT"

range

  range(number | string @args) (arrayref)

The range function returns the result of a "range" in Venus::Array operation.

Since 3.20

range example 1

  package main;
  use Venus 'range';
  my $range = range [1..9], ':4';
  # [1..5]

range example 2

  package main;
  use Venus 'range';
  my $range = range [1..9], '-4:-1';
  # [6..9]

read_env

  read_env(string $data) (Venus::Config)

The read_env function returns a new Venus::Config object based on the string of key/value pairs provided.

Since 4.15

read_env example 1

  package main;
  use Venus 'read_env';
  my $read_env = read_env "APPNAME=Example\nAPPVER=0.01\n# Comment\n\n\nAPPTAG=\"Godzilla\"";
  # bless(..., 'Venus::Config')

read_env_file

  read_env_file(string $file) (Venus::Config)

The read_env_file function uses Venus::Path to return a new Venus::Config object based on the file provided.

Since 4.15

read_env_file example 1

  package main;
  use Venus 'read_env_file';
  my $config = read_env_file 't/conf/read.env';
  # bless(..., 'Venus::Config')

read_json

  read_json(string $data) (Venus::Config)

The read_json function returns a new Venus::Config object based on the JSON string provided.

Since 4.15

read_json example 1

  package main;
  use Venus 'read_json';
  my $config = read_json q(
  {
    "$metadata": {
      "tmplog": "/tmp/log"
    },
    "$services": {
      "log": { "package": "Venus/Path", "argument": { "$metadata": "tmplog" } }
    }
  }
  );
  # bless(..., 'Venus::Config')

read_json_file

  read_json_file(string $file) (Venus::Config)

The read_json_file function uses Venus::Path to return a new Venus::Config object based on the file provided.

Since 4.15

read_json_file example 1

  package main;
  use Venus 'read_json_file';
  my $config = read_json_file 't/conf/read.json';
  # bless(..., 'Venus::Config')

read_perl

  read_perl(string $data) (Venus::Config)

The read_perl function returns a new Venus::Config object based on the Perl string provided.

Since 4.15

read_perl example 1

  package main;
  use Venus 'read_perl';
  my $config = read_perl q(
  {
    '$metadata' => {
      tmplog => "/tmp/log"
    },
    '$services' => {
      log => { package => "Venus/Path", argument => { '$metadata' => "tmplog" } }
    }
  }
  );
  # bless(..., 'Venus::Config')

read_perl_file

  read_perl_file(string $file) (Venus::Config)

The read_perl_file function uses Venus::Path to return a new Venus::Config object based on the file provided.

Since 4.15

read_perl_file example 1

  package main;
  use Venus 'read_perl_file';
  my $config = read_perl_file 't/conf/read.perl';
  # bless(..., 'Venus::Config')

read_yaml

  read_yaml(string $data) (Venus::Config)

The read_yaml function returns a new Venus::Config object based on the YAML string provided.

Since 4.15

read_yaml example 1

  package main;
  use Venus 'read_yaml';
  my $config = read_yaml q(
  '$metadata':
    tmplog: /tmp/log
  '$services':
    log:
      package: "Venus/Path"
      argument:
        '$metadata': tmplog
  );
  # bless(..., 'Venus::Config')

read_yaml_file

  read_yaml_file(string $file) (Venus::Config)

The read_yaml_file function uses Venus::Path to return a new Venus::Config object based on the YAML string provided.

Since 4.15

read_yaml_file example 1

  package main;
  use Venus 'read_yaml_file';
  my $config = read_yaml_file 't/conf/read.yaml';
  # bless(..., 'Venus::Config')

regexp

  regexp(string $value, string | coderef $code, any @args) (any)

The regexp function builds and returns a Venus::Regexp object, or dispatches to the coderef or method provided.

Since 2.55

regexp example 1

  package main;
  use Venus 'regexp';
  my $regexp = regexp '[0-9]';
  # bless({...}, 'Venus::Regexp')

regexp example 2

  package main;
  use Venus 'regexp';
  my $replace = regexp '[0-9]', 'replace', 'ID 12345', '0', 'g';
  # bless({...}, 'Venus::Replace')
  # $replace->get;
  # "ID 00000"

render

  render(string $data, hashref $args) (string)

The render function accepts a string as a template and renders it using Venus::Template, and returns the result.

Since 3.04

render example 1

  package main;
  use Venus 'render';
  my $render = render 'hello {{name}}', {
    name => 'user',
  };
  # "hello user"

replace

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

The replace function builds and returns a Venus::Replace object, or dispatches to the coderef or method provided.

Since 2.55

replace example 1

  package main;
  use Venus 'replace';
  my $replace = replace ['hello world', 'world', 'universe'];
  # bless({...}, 'Venus::Replace')

replace example 2

  package main;
  use Venus 'replace';
  my $replace = replace ['hello world', 'world', 'universe'], 'get';
  # "hello universe"

roll

  roll(string $name, any @args) (any)

The roll function takes a list of arguments, assuming the first argument is invokable, and reorders the list such that the routine name provided comes after the invocant (i.e. the 1st argument), creating a list acceptable to the "call" function.

Since 2.32

roll example 1

  package main;
  use Venus 'roll';
  my @list = roll('sha1_hex', 'Digest::SHA');
  # ('Digest::SHA', 'sha1_hex');

roll example 2

  package main;
  use Venus 'roll';
  my @list = roll('sha1_hex', call(\'Digest::SHA', 'new'));
  # (bless(do{\(my $o = '...')}, 'Digest::SHA'), 'sha1_hex');

schema

  schema(string | coderef $code, any @args) (Venus::Schema)

The schema function builds and returns a Venus::Schema object, or dispatches to the coderef or method provided.

Since 4.15

schema example 1

  package main;
  use Venus 'schema';
  my $schema = schema;
  # bless({...}, "Venus::Schema")

schema example 2

  package main;
  use Venus 'schema';
  my $schema = schema 'rule', {
    selector => 'handles',
    presence => 'required',
    executes => [['type', 'arrayref']],
  };
  # bless({...}, "Venus::Schema")

schema example 3

  package main;
  use Venus 'schema';
  my $schema = schema 'rules', {
    selector => 'fname',
    presence => 'required',
    executes => ['string', 'trim', 'strip'],
  },{
    selector => 'lname',
    presence => 'required',
    executes => ['string', 'trim', 'strip'],
  };
  # bless({...}, "Venus::Schema")

search

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

The search function builds and returns a Venus::Search object, or dispatches to the coderef or method provided.

Since 2.55

search example 1

  package main;
  use Venus 'search';
  my $search = search ['hello world', 'world'];
  # bless({...}, 'Venus::Search')

search example 2

  package main;
  use Venus 'search';
  my $search = search ['hello world', 'world'], 'count';
  # 1

set

  set(arrayref $value) (Venus::Set)

The set function returns a Venus::Set object for the arrayref provided.

Since 4.11

set example 1

  package main;
  use Venus;
  my $set = Venus::set [1..9];
  # bless(..., 'Venus::Set')

set example 2

  package main;
  use Venus;
  my $set = Venus::set [1..9], 'count';
  # 9

sets

  sets(string @args) (arrayref)

The sets function find values from within the underlying data structure using "path" in Venus::Array or "path" in Venus::Hash, where each argument pair is a selector and value, and returns all the values provided. Returns a list in list context. Note, nested data structures can be updated but not created.

Since 4.15

sets example 1

  package main;
  use Venus 'sets';
  my $data = ['foo', {'bar' => 'baz'}, 'bar', ['baz']];
  my $sets = sets $data, '3' => 'bar', '1.bar' => 'bar';
  # ['bar', 'bar']

sets example 2

  package main;
  use Venus 'sets';
  my $data = ['foo', {'bar' => 'baz'}, 'bar', ['baz']];
  my ($baz, $one_bar) = sets $data, '3' => 'bar', '1.bar' => 'bar';
  # ('bar', 'bar')

sets example 3

  package main;
  use Venus 'sets';
  my $data = {'foo' => {'bar' => 'baz'}, 'bar' => ['baz']};
  my $sets = sets $data, 'bar' => 'bar', 'foo.bar' => 'bar';
  # ['bar', 'bar']

sets example 4

  package main;
  use Venus 'sets';
  my $data = {'foo' => {'bar' => 'baz'}, 'bar' => ['baz']};
  my ($bar, $foo_bar) = sets $data, 'bar' => 'bar', 'foo.bar' => 'bar';
  # ('bar', 'bar')

sorts

  sorts(any @args) (any)

The sorts function accepts a list of values, flattens any arrayrefs, and sorts it using the default sort(LIST) call style exclusively.

Since 4.15

sorts example 1

  package main;
  use Venus 'sorts';
  my @sorts = sorts 1..4;
  # (1..4)

sorts example 2

  package main;
  use Venus 'sorts';
  my @sorts = sorts 4,3,2,1;
  # (1..4)

sorts example 3

  package main;
  use Venus 'sorts';
  my @sorts = sorts [1..4], 5, [6..9];
  # (1..9)

space

  space(any $name) (Venus::Space)

The space function returns a Venus::Space object for the package provided.

Since 2.32

space example 1

  package main;
  use Venus 'space';
  my $space = space 'Venus::Scalar';
  # bless({value => 'Venus::Scalar'}, 'Venus::Space')

string

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

The string function builds and returns a Venus::String object, or dispatches to the coderef or method provided.

Since 2.55

string example 1

  package main;
  use Venus 'string';
  my $string = string 'hello world';
  # bless({...}, 'Venus::String')

string example 2

  package main;
  use Venus 'string';
  my $string = string 'hello world', 'camelcase';
  # "helloWorld"

syscall

  syscall(number | string @args) (any)

The syscall function perlforms system call, i.e. a "qx" in perlfunc operation, and returns "true" if the command succeeds, otherwise returns "false". In list context, returns the output of the operation and the exit code.

Since 3.04

syscall example 1

  package main;
  use Venus 'syscall';
  my $syscall = syscall 'perl', '-v';
  # true

syscall example 2

  package main;
  use Venus 'syscall';
  my $syscall = syscall 'perl', '-z';
  # false

syscall example 3

  package main;
  use Venus 'syscall';
  my ($data, $code) = syscall 'sun', '--heat-death';
  # ('done', 0)

syscall example 4

  package main;
  use Venus 'syscall';
  my ($data, $code) = syscall 'earth', '--melt-icecaps';
  # ('', 127)

template

  template(string $value, string | coderef $code, any @args) (any)

The template function builds and returns a Venus::Template object, or dispatches to the coderef or method provided.

Since 2.55

template example 1

  package main;
  use Venus 'template';
  my $template = template 'Hi {{name}}';
  # bless({...}, 'Venus::Template')

template example 2

  package main;
  use Venus 'template';
  my $template = template 'Hi {{name}}', 'render', undef, {
    name => 'stranger',
  };
  # "Hi stranger"

test

  test(string $value, string | coderef $code, any @args) (any)

The test function builds and returns a Venus::Test object, or dispatches to the coderef or method provided.

Since 2.55

test example 1

  package main;
  use Venus 'test';
  my $test = test 't/Venus.t';
  # bless({...}, 'Venus::Test')

test example 2

  package main;
  use Venus 'test';
  my $test = test 't/Venus.t', 'for', 'synopsis';
  # bless({...}, 'Venus::Test')

text_pod

  text_pod(string $value, string | coderef $code, any @args) (any)

The text_pod function builds and returns a Venus::Text::Pod object, or dispatches to the coderef or method provided.

Since 4.15

text_pod example 1

  package main;
  use Venus 'text_pod';
  my $text_pod = text_pod 't/data/sections';
  # bless({...}, 'Venus::Text::Pod')

text_pod example 2

  package main;
  use Venus 'text_pod';
  my $text_pod = text_pod 't/data/sections', 'string', undef, 'name';
  # "Example #1\nExample #2"

text_pod_string

  text_pod_string(any @args) (any)

The text_pod_string function builds a Venus::Text::Pod object for the current file, i.e. "__FILE__" in perlfunc or script, i.e. $0, and returns the result of a "string" in Venus::Text::Pod operation using the arguments provided.

Since 4.15

text_pod_string example 1

  package main;
  use Venus 'text_pod_string';
  # =name
  #
  # Example #1
  #
  # =cut
  #
  # =name
  #
  # Example #2
  #
  # =cut
  #
  # =head1 NAME
  #
  # Example #1
  #
  # =cut
  #
  # =head1 NAME
  #
  # Example #2
  #
  # =cut
  #
  # =head1 ABSTRACT
  #
  # Example Abstract
  #
  # =cut
  my $text_pod_string = text_pod_string 'name';
  # "Example #1\nExample #2"

text_pod_string example 2

  package main;
  use Venus 'text_pod_string';
  # =name
  #
  # Example #1
  #
  # =cut
  #
  # =name
  #
  # Example #2
  #
  # =cut
  #
  # =head1 NAME
  #
  # Example #1
  #
  # =cut
  #
  # =head1 NAME
  #
  # Example #2
  #
  # =cut
  #
  # =head1 ABSTRACT
  #
  # Example Abstract
  #
  # =cut
  my $text_pod_string = text_pod_string 'head1', 'ABSTRACT';
  # "Example Abstract"

text_tag

  text_tag(string $value, string | coderef $code, any @args) (any)

The text_tag function builds and returns a Venus::Text::Tag object, or dispatches to the coderef or method provided.

Since 4.15

text_tag example 1

  package main;
  use Venus 'text_tag';
  my $text_tag = text_tag 't/data/sections';
  # bless({...}, 'Venus::Text::Tag')

text_tag example 2

  package main;
  use Venus 'text_tag';
  my $text_tag = text_tag 't/data/sections', 'string', undef, 'name';
  # "Example Name"

text_tag_string

  text_tag_string(any @args) (any)

The text_tag_string function builds a Venus::Text::Tag object for the current file, i.e. "__FILE__" in perlfunc or script, i.e. $0, and returns the result of a "string" in Venus::Text::Tag operation using the arguments provided.

Since 4.15

text_tag_string example 1

  package main;
  use Venus 'text_tag_string';
  # @@ name
  #
  # Example Name
  #
  # @@ end
  #
  # @@ titles #1
  #
  # Example Title #1
  #
  # @@ end
  #
  # @@ titles #2
  #
  # Example Title #2
  #
  # @@ end
  my $text_tag_string = text_tag_string 'name';
  # "Example Name"

text_tag_string example 2

  package main;
  use Venus 'text_tag_string';
  # @@ name
  #
  # Example Name
  #
  # @@ end
  #
  # @@ titles #1
  #
  # Example Title #1
  #
  # @@ end
  #
  # @@ titles #2
  #
  # Example Title #2
  #
  # @@ end
  my $text_tag_string = text_tag_string 'titles', '#1';
  # "Example Title #1"

text_tag_string example 3

  package main;
  use Venus 'text_tag_string';
  # @@ name
  #
  # Example Name
  #
  # @@ end
  #
  # @@ titles #1
  #
  # Example Title #1
  #
  # @@ end
  #
  # @@ titles #2
  #
  # Example Title #2
  #
  # @@ end
  my $text_tag_string = text_tag_string undef, 'name';
  # "Example Name"

then

  then(string | object | coderef $self, any @args) (any)

The then function proxies the call request to the "call" function and returns the result as a list, prepended with the invocant.

Since 2.32

then example 1

  package main;
  use Venus 'then';
  my @list = then('Digest::SHA', 'sha1_hex');
  # ("Digest::SHA", "da39a3ee5e6b4b0d3255bfef95601890afd80709")

throw

  throw(string | hashref $value, string | coderef $code, any @args) (any)

The throw function builds and returns a Venus::Throw object, or dispatches to the coderef or method provided.

Since 2.55

throw example 1

  package main;
  use Venus 'throw';
  my $throw = throw 'Example::Error';
  # bless({...}, 'Venus::Throw')

throw example 2

  package main;
  use Venus 'throw';
  my $throw = throw 'Example::Error', 'error';
  # bless({...}, 'Example::Error')

throw example 3

  package main;
  use Venus 'throw';
  my $throw = throw {
    name => 'on.execute',
    package => 'Example::Error',
    capture => ['...'],
    stash => {
      time => time,
    },
  };
  # bless({...}, 'Venus::Throw')

true

  true() (boolean)

The true function returns a truthy boolean value which is designed to be practically indistinguishable from the conventional numerical 1 value.

Since 0.01

true example 1

  package main;
  use Venus;
  my $true = true;
  # 1

true example 2

  package main;
  use Venus;
  my $false = !true;
  # 0

try

  try(any $data, string | coderef $code, any @args) (any)

The try function builds and returns a Venus::Try object, or dispatches to the coderef or method provided.

Since 2.55

try example 1

  package main;
  use Venus 'try';
  my $try = try sub {};
  # bless({...}, 'Venus::Try')
  # my $result = $try->result;
  # ()

try example 2

  package main;
  use Venus 'try';
  my $try = try sub { die };
  # bless({...}, 'Venus::Try')
  # my $result = $try->result;
  # Exception! (isa Venus::Error)

try example 3

  package main;
  use Venus 'try';
  my $try = try sub { die }, 'maybe';
  # bless({...}, 'Venus::Try')
  # my $result = $try->result;
  # undef

tv

  tv(any $lvalue, any $rvalue) (boolean)

The tv function compares the lvalue and rvalue and returns true if they have the same type and value, otherwise returns false. b<Note:> Comparison of coderefs, filehandles, and blessed objects with private state are impossible. This function will only return true if these data types are "identical". It's also impossible to know which blessed objects have private state and therefore could produce false-positives when comparing object in those cases.

Since 4.15

tv example 1

  # given: synopsis
  package main;
  use Venus 'tv';
  my $tv = tv 1, 1;
  # true

tv example 2

  # given: synopsis
  package main;
  use Venus 'tv';
  my $tv = tv '1', 1;
  # false

tv example 3

  # given: synopsis
  package main;
  use Venus 'tv';
  my $tv = tv ['0', 1..4], ['0', 1..4];
  # true

tv example 4

  # given: synopsis
  package main;
  use Venus 'tv';
  my $tv = tv ['0', 1..4], [0, 1..4];
  # false

tv example 5

  # given: synopsis
  package main;
  use Venus 'tv';
  my $tv = tv undef, undef;
  # true

tv example 6

  # given: synopsis
  package main;
  use Venus 'number', 'tv';
  my $a = number 1;
  my $tv = tv $a, undef;
  # false

tv example 7

  # given: synopsis
  package main;
  use Venus 'number', 'tv';
  my $a = number 1;
  my $tv = tv $a, $a;
  # true

tv example 8

  # given: synopsis
  package main;
  use Venus 'number', 'tv';
  my $a = number 1;
  my $b = number 1;
  my $tv = tv $a, $b;
  # true

tv example 9

  # given: synopsis
  package main;
  use Venus 'number', 'tv';
  my $a = number 0;
  my $b = number 1;
  my $tv = tv $a, $b;
  # false

type

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

The type function builds and returns a Venus::Type object, or dispatches to the coderef or method provided.

Since 4.15

type example 1

  package main;
  use Venus 'type';
  my $type = type;
  # bless({...}, 'Venus::Type')

type example 2

  package main;
  use Venus 'type';
  my $expression = type 'expression', 'string | number';
  # ["either", "string", "number"]

type example 3

  package main;
  use Venus 'type';
  my $expression = type 'expression', ["either", "string", "number"];
  # "string | number"

unpack

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

The unpack function builds and returns a Venus::Unpack object.

Since 2.40

unpack example 1

  package main;
  use Venus 'unpack';
  my $unpack = unpack;
  # bless({...}, 'Venus::Unpack')
  # $unpack->checks('string');
  # false
  # $unpack->checks('undef');
  # false

unpack example 2

  package main;
  use Venus 'unpack';
  my $unpack = unpack rand;
  # bless({...}, 'Venus::Unpack')
  # $unpack->check('number');
  # false
  # $unpack->check('float');
  # true

vars

  vars(hashref $value, string | coderef $code, any @args) (any)

The vars function builds and returns a Venus::Vars object, or dispatches to the coderef or method provided.

Since 2.55

vars example 1

  package main;
  use Venus 'vars';
  my $vars = vars {};
  # bless({...}, 'Venus::Vars')

vars example 2

  package main;
  use Venus 'vars';
  my $path = vars {}, 'exists', 'path';
  # "..."

vns

  vns(string $name, args $args, string | coderef $callback, any @args) (any)

The vns function build a Venus package based on the name provided, loads and instantiates the package, and returns an instance of that package or dispatches to the method provided and returns the result.

Since 4.15

vns example 1

  package main;
  use Venus 'vns';
  my $space = vns 'space';
  # bless({value => 'Venus'}, 'Venus::Space')

vns example 2

  package main;
  use Venus 'vns';
  my $space = vns 'space', 'Venus::String';
  # bless({value => 'Venus::String'}, 'Venus::Space')

vns example 3

  package main;
  use Venus 'vns';
  my $code = vns 'code', sub{};
  # bless({value => sub{...}}, 'Venus::Code')

what

  what(any $data, string | coderef $code, any @args) (any)

The what function builds and returns a Venus::What object, or dispatches to the coderef or method provided.

Since 4.11

what example 1

  package main;
  use Venus 'what';
  my $what = what [1..4];
  # bless({...}, 'Venus::What')
  # $what->deduce;
  # bless({...}, 'Venus::Array')

what example 2

  package main;
  use Venus 'what';
  my $what = what [1..4], 'deduce';
  # bless({...}, 'Venus::Array')

work

  work(coderef $callback) (Venus::Process)

The work function builds a Venus::Process object, forks the current process using the callback provided via the "work" in Venus::Process operation, and returns an instance of Venus::Process representing the current process.

Since 2.40

work example 1

  package main;
  use Venus 'work';
  my $parent = work sub {
    my ($process) = @_;
    # in forked process ...
    $process->exit;
  };
  # bless({...}, 'Venus::Process')

wrap

  wrap(string $data, string $name) (coderef)

The wrap function installs a wrapper function in the calling package which when called either returns the package string if no arguments are provided, or calls "make" on the package with whatever arguments are provided and returns the result. Unless an alias is provided as a second argument, special characters are stripped from the package to create the function name.

Since 2.32

wrap example 1

  package main;
  use Venus 'wrap';
  my $coderef = wrap('Digest::SHA');
  # sub { ... }
  # my $digest = DigestSHA();
  # "Digest::SHA"
  # my $digest = DigestSHA(1);
  # bless(do{\(my $o = '...')}, 'Digest::SHA')

wrap example 2

  package main;
  use Venus 'wrap';
  my $coderef = wrap('Digest::SHA', 'SHA');
  # sub { ... }
  # my $digest = SHA();
  # "Digest::SHA"
  # my $digest = SHA(1);
  # bless(do{\(my $o = '...')}, 'Digest::SHA')

write_env

  write_env(hashref $data) (string)

The write_env function returns a string representing environment variable key/value pairs based on the "value" held by the underlying Venus::Config object.

Since 4.15

write_env example 1

  package main;
  use Venus 'write_env';
  my $write_env = write_env {
    APPNAME => "Example",
    APPTAG => "Godzilla",
    APPVER => 0.01,
  };
  # "APPNAME=Example\nAPPTAG=Godzilla\nAPPVER=0.01"

write_env_file

  write_env_file(string $path, hashref $data) (Venus::Config)

The write_env_file function saves a environment configuration file and returns a new Venus::Config object.

Since 4.15

write_env_file example 1

  package main;
  use Venus 'write_env_file';
  my $write_env_file = write_env_file 't/conf/write.env', {
    APPNAME => "Example",
    APPTAG => "Godzilla",
    APPVER => 0.01,
  };
  # bless(..., 'Venus::Config')

write_json

  write_json(hashref $data) (string)

The write_json function returns a JSON encoded string based on the "value" held by the underlying Venus::Config object.

Since 4.15

write_json example 1

  package main;
  use Venus 'write_json';
  my $write_json = write_json {
    '$services' => {
      log => { package => "Venus::Path" },
    },
  };
  # '{ "$services":{ "log":{ "package":"Venus::Path" } } }'

write_json_file

  write_json_file(string $path, hashref $data) (Venus::Config)

The write_json_file function saves a JSON configuration file and returns a new Venus::Config object.

Since 4.15

write_json_file example 1

  package main;
  use Venus 'write_json_file';
  my $write_json_file = write_json_file 't/conf/write.json', {
    '$services' => {
      log => { package => "Venus/Path", argument => { value => "." } }
    }
  };
  # bless(..., 'Venus::Config')

write_perl

  write_perl(hashref $data) (string)

The write_perl function returns a FILE encoded string based on the "value" held by the underlying Venus::Config object.

Since 4.15

write_perl example 1

  package main;
  use Venus 'write_perl';
  my $write_perl = write_perl {
    '$services' => {
      log => { package => "Venus::Path" },
    },
  };
  # '{ "\$services" => { log => { package => "Venus::Path" } } }'

write_perl_file

  write_perl_file(string $path, hashref $data) (Venus::Config)

The write_perl_file function saves a Perl configuration file and returns a new Venus::Config object.

Since 4.15

write_perl_file example 1

  package main;
  use Venus 'write_perl_file';
  my $write_perl_file = write_perl_file 't/conf/write.perl', {
    '$services' => {
      log => { package => "Venus/Path", argument => { value => "." } }
    }
  };
  # bless(..., 'Venus::Config')

write_yaml

  write_yaml(hashref $data) (string)

The write_yaml function returns a FILE encoded string based on the "value" held by the underlying Venus::Config object.

Since 4.15

write_yaml example 1

  package main;
  use Venus 'write_yaml';
  my $write_yaml = write_yaml {
    '$services' => {
      log => { package => "Venus::Path" },
    },
  };
  # '---\n$services:\n\s\slog:\n\s\s\s\spackage:\sVenus::Path'

write_yaml_file

  write_yaml_file(string $path, hashref $data) (Venus::Config)

The write_yaml_file function saves a YAML configuration file and returns a new Venus::Config object.

Since 4.15

write_yaml_file example 1

  package main;
  use Venus 'write_yaml_file';
  my $write_yaml_file = write_yaml_file 't/conf/write.yaml', {
    '$services' => {
      log => { package => "Venus/Path", argument => { value => "." } }
    }
  };
  # bless(..., 'Venus::Config')

yaml

  yaml(string $call, any $data) (any)

The yaml function builds a Venus::Yaml object and will either "decode" in Venus::Yaml or "encode" in Venus::Yaml based on the argument provided and returns the result.

Since 2.40

yaml example 1

  package main;
  use Venus 'yaml';
  my $decode = yaml 'decode', "---\nname:\n- Ready\n- Robot\nstable: true\n";
  # { name => ["Ready", "Robot"], stable => 1 }

yaml example 2

  package main;
  use Venus 'yaml';
  my $encode = yaml 'encode', { name => ["Ready", "Robot"], stable => true };
  # '---\nname:\n- Ready\n- Robot\nstable: true\n'

yaml example 3

  package main;
  use Venus 'yaml';
  my $yaml = yaml;
  # bless({...}, 'Venus::Yaml')

yaml example 4

  package main;
  use Venus 'yaml';
  my $yaml = yaml 'class', {data => "..."};
  # Exception! (isa Venus::Fault)

FEATURES

This package provides the following features:

venus-args: This library contains a Venus::Args class which provides methods for accessing @ARGS items.
venus-array: This library contains a Venus::Array class which provides methods for manipulating array data.
venus-assert: This library contains a Venus::Assert class which provides a mechanism for asserting type constraints and coercion.
venus-atom: This library contains a Venus::Atom class which provides a write-once object representing a constant value.
venus-boolean: This library contains a Venus::Boolean class which provides a representation for boolean values.
venus-box: This library contains a Venus::Box class which provides a pure Perl boxing mechanism.
venus-call: This library contains a Venus::Call class which provides a protocol for dynamically invoking methods with optional opt-in type safety.
venus-check: This library contains a Venus::Check class which provides runtime dynamic type checking.
venus-class: This library contains a Venus::Class class which provides a class builder.
venus-cli: This library contains a Venus::Cli class which provides a superclass for creating CLIs.
venus-code: This library contains a Venus::Code class which provides methods for manipulating subroutines.
venus-coercion: This library contains a Venus::Coercion class which provides data type coercions via Venus::Check.
venus-collect: This library contains a Venus::Collect class which provides a mechanism for iterating over mappable values.
venus-config: This library contains a Venus::Config class which provides methods for loading Perl, YAML, and JSON configuration data.
venus-constraint: This library contains a Venus::Constraint class which provides data type constraints via Venus::Check.
venus-data: This library contains a Venus::Data class which provides value object for encapsulating data validation.
venus-date: This library contains a Venus::Date class which provides methods for formatting, parsing, and manipulating dates.
venus-dump: This library contains a Venus::Dump class which provides methods for reading and writing dumped Perl data.
venus-enum: This library contains a Venus::Enum class which provides an interface for working with enumerations.
venus-error: This library contains a Venus::Error class which represents a context-aware error (exception object).
venus-factory: This library contains a Venus::Factory class which provides an object-oriented factory pattern for building objects.
venus-false: This library contains a Venus::False class which provides the global "false" value.
venus-fault: This library contains a Venus::Fault class which represents a generic system error (exception object).
venus-float: This library contains a Venus::Float class which provides methods for manipulating float data.
venus-future: This library contains a Venus::Future class which provides a framework-agnostic implementation of the Future pattern.
venus-gather: This library contains a Venus::Gather class which provides an object-oriented interface for complex pattern matching operations on collections of data, e.g. array references.
venus-hash: This library contains a Venus::Hash class which provides methods for manipulating hash data.
venus-json: This library contains a Venus::Json class which provides methods for reading and writing JSON data.
venus-log: This library contains a Venus::Log class which provides methods for logging information using various log levels.
venus-map: This library contains a Venus::Map class which provides a representation of a collection of ordered key/value pairs.
venus-match: This library contains a Venus::Match class which provides an object-oriented interface for complex pattern matching operations on scalar values.
venus-meta: This library contains a Venus::Meta class which provides configuration information for Venus derived classes.
venus-mixin: This library contains a Venus::Mixin class which provides a mixin builder.
venus-name: This library contains a Venus::Name class which provides methods for parsing and formatting package namespaces.
venus-number: This library contains a Venus::Number class which provides methods for manipulating number data.
venus-opts: This library contains a Venus::Opts class which provides methods for handling command-line arguments.
venus-os: This library contains a Venus::Os class which provides methods for determining the current operating system, as well as finding and executing files.
venus-path: This library contains a Venus::Path class which provides methods for working with file system paths.
venus-process: This library contains a Venus::Process class which provides methods for handling and forking processes.
venus-prototype: This library contains a Venus::Prototype class which provides a simple construct for enabling prototype-base programming.
venus-random: This library contains a Venus::Random class which provides an object-oriented interface for Perl's pseudo-random number generator.
venus-range: This library contains a Venus::Range class which provides an object-oriented interface for selecting elements from an arrayref using range expressions.
venus-regexp: This library contains a Venus::Regexp class which provides methods for manipulating regexp data.
venus-replace: This library contains a Venus::Replace class which provides methods for manipulating regexp replacement data.
venus-result: This library contains a Venus::Result class which provides a container for representing success and error states.
venus-run: This library contains a Venus::Run class which provides a base class for providing a command execution system for creating CLIs (command-line interfaces).
venus-scalar: This library contains a Venus::Scalar class which provides methods for manipulating scalar data.
venus-schema: This library contains a Venus::Schema class which provides a mechanism for validating complex data structures.
venus-sealed: This library contains a Venus::Sealed class which provides a mechanism for restricting access to the underlying data structure.
venus-search: This library contains a Venus::Search class which provides methods for manipulating regexp search data.
venus-set: This library contains a Venus::Set class which provides a representation of a collection of ordered key/value pairs.
venus-space: This library contains a Venus::Space class which provides methods for parsing and manipulating package namespaces.
venus-string: This library contains a Venus::String class which provides methods for manipulating string data.
venus-task: This library contains a Venus::Task class which provides a base class for creating CLIs (command-line interfaces).
venus-template: This library contains a Venus::Template class which provides a templating system, and methods for rendering template.
venus-test: This library contains a Venus::Test class which aims to provide a standard for documenting Venus derived software projects.
venus-text: This library contains a Venus::Text class which provides methods for extracting "DATA" sections and POD block.
venus-text-pod: This library contains a Venus::Text::Pod class which provides methods for extracting POD blocks.
venus-text-tag: This library contains a Venus::Text::Tag class which provides methods for extracting "DATA" sections.
venus-throw: This library contains a Venus::Throw class which provides a mechanism for generating and raising error objects.
venus-true: This library contains a Venus::True class which provides the global "true" value.
venus-try: This library contains a Venus::Try class which provides an object-oriented interface for performing complex try/catch operations.
venus-type: This library contains a Venus::Type class which provides a mechanism for parsing, generating, and validating data type expressions.
venus-undef: This library contains a Venus::Undef class which provides methods for manipulating undef data.
venus-unpack: This library contains a Venus::Unpack class which provides methods for validating, coercing, and otherwise operating on lists of arguments.
venus-validate: This library contains a Venus::Validate class which provides a mechanism for performing data validation of simple and hierarchal data.
venus-vars: This library contains a Venus::Vars class which provides methods for accessing %ENV items.
venus-what: This library contains a Venus::What class which provides methods for casting native data types to objects.
venus-yaml: This library contains a Venus::Yaml class which provides methods for reading and writing YAML data.

AUTHORS

Awncorp, "awncorp@cpan.org"

LICENSE

This program is free software, you can redistribute it and/or modify it under the terms of the Apache license version 2.0.