G. Wade Johnson > App-TimelogTxt-0.12 > App::TimelogTxt::Stack

Download:
App-TimelogTxt-0.12.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 0.12   Source  

NAME ^

App::TimelogTxt::Stack - Interface to the stack file for the timelog application.

VERSION ^

This document describes App::TimelogTxt::Stack version 0.12

SYNOPSIS ^

    use App::TimelogTxt::Stack;

    my $stack = App::TimelogTxt::Stack->new( 'timelog/stack.txt' );

    $stack->push( '+Project @Task More detail' );
    my $event = $stack->pop();

DESCRIPTION ^

INTERFACE ^

new( $filename )

Create an App::TimelogTxt::Stack object wrapping the supplied file.

$s->clear()

Truncate the stack file, removing all items from the stack.

$s->push( $event )

Add a new event to the stack file.

$event = $s->pop()

Remove the most recent event from the stack file and return the event string.

$s->drop( $arg )

Remove one or more events from the stack file. If $arg is not supplied, remove one item. If $arg is a positive number, remove that many items from the stack. If $arg is the string 'all', clear the stack.

$s->list( $fh )

Print the stack to the supplied filehandle. If no filehandle is supplied, use STDOUT. The stack will be printed such that the most recent item is listed first.

CONFIGURATION AND ENVIRONMENT ^

App::TimelogTxt::Stack requires no configuration files or environment variables.

DEPENDENCIES ^

autodie.

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

AUTHOR ^

G. Wade Johnson gwadej@cpan.org

LICENCE AND COPYRIGHT ^

Copyright (c) 2013, G. Wade Johnson gwadej@cpan.org. All rights reserved.

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

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: