/ 
Text-Pipe-0.01
River stage one • 6 direct dependents • 6 total dependents
/ Text::Pipe::Multiplex

NAME

Text::Pipe::Multiplex - Common text filter API

SYNOPSIS

Text::Pipe::Multiplex->new;

DESCRIPTION

Text::Pipe::Multiplex inherits from Text::Pipe::Base.

Methods inherited from Text::Pipe::Base:

new()

METHODS

clear_pipes
$obj->clear_pipes;

Deletes all elements from the array. =item count_pipes

my $count = $obj->count_pipes;

Returns the number of elements in the array. =item index_pipes

my $element   = $obj->index_pipes(3);
my @elements  = $obj->index_pipes(@indices);
my $array_ref = $obj->index_pipes(@indices);

Takes a list of indices and returns the elements indicated by those indices. If only one index is given, the corresponding array element is returned. If several indices are given, the result is returned as an array in list context or as an array reference in scalar context. =item pipes

my @values    = $obj->pipes;
my $array_ref = $obj->pipes;
$obj->pipes(@values);
$obj->pipes($array_ref);

Get or set the array values. If called without an arguments, it returns the array in list context, or a reference to the array in scalar context. If called with arguments, it expands array references found therein and sets the values. =item pipes_clear

$obj->pipes_clear;

Deletes all elements from the array. =item pipes_count

my $count = $obj->pipes_count;

Returns the number of elements in the array. =item pipes_index

my $element   = $obj->pipes_index(3);
my @elements  = $obj->pipes_index(@indices);
my $array_ref = $obj->pipes_index(@indices);

Takes a list of indices and returns the elements indicated by those indices. If only one index is given, the corresponding array element is returned. If several indices are given, the result is returned as an array in list context or as an array reference in scalar context. =item pipes_pop

my $value = $obj->pipes_pop;

Pops the last element off the array, returning it. =item pipes_push

$obj->pipes_push(@values);

Pushes elements onto the end of the array. =item pipes_set

$obj->pipes_set(1 => $x, 5 => $y);

Takes a list of index/value pairs and for each pair it sets the array element at the indicated index to the indicated value. Returns the number of elements that have been set. =item pipes_shift

my $value = $obj->pipes_shift;

Shifts the first element off the array, returning it. =item pipes_splice

$obj->pipes_splice(2, 1, $x, $y);
$obj->pipes_splice(-1);
$obj->pipes_splice(0, -1);

Takes three arguments: An offset, a length and a list.

Removes the elements designated by the offset and the length from the array, and replaces them with the elements of the list, if any. In list context, returns the elements removed from the array. In scalar context, returns the last element removed, or undef if no elements are removed. The array grows or shrinks as necessary. If the offset is negative then it starts that far from the end of the array. If the length is omitted, removes everything from the offset onward. If the length is negative, removes the elements from the offset onward except for -length elements at the end of the array. If both the offset and the length are omitted, removes everything. If the offset is past the end of the array, it issues a warning, and splices at the end of the array. =item pipes_unshift

$obj->pipes_unshift(@values);

Unshifts elements onto the beginning of the array. =item pop_pipes

my $value = $obj->pop_pipes;

Pops the last element off the array, returning it. =item push_pipes

$obj->push_pipes(@values);

Pushes elements onto the end of the array. =item set_pipes

$obj->set_pipes(1 => $x, 5 => $y);

Takes a list of index/value pairs and for each pair it sets the array element at the indicated index to the indicated value. Returns the number of elements that have been set. =item shift_pipes

my $value = $obj->shift_pipes;

Shifts the first element off the array, returning it. =item splice_pipes

$obj->splice_pipes(2, 1, $x, $y);
$obj->splice_pipes(-1);
$obj->splice_pipes(0, -1);

Takes three arguments: An offset, a length and a list.

Removes the elements designated by the offset and the length from the array, and replaces them with the elements of the list, if any. In list context, returns the elements removed from the array. In scalar context, returns the last element removed, or undef if no elements are removed. The array grows or shrinks as necessary. If the offset is negative then it starts that far from the end of the array. If the length is omitted, removes everything from the offset onward. If the length is negative, removes the elements from the offset onward except for -length elements at the end of the array. If both the offset and the length are omitted, removes everything. If the offset is past the end of the array, it issues a warning, and splices at the end of the array. =item unshift_pipes

$obj->unshift_pipes(@values);

Unshifts elements onto the beginning of the array.

TAGS

If you talk about this module in blogs, on del.icio.us or anywhere else, please use the textpipe tag.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to <bug-text-pipe@rt.cpan.org>, or through the web interface at http://rt.cpan.org.

INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>.

AUTHOR

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE

Copyright 2007 by Marcel Grünauer

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.