View on
MetaCPAN
Shlomi Fish > File-Find-Object > File::Find::Object::Result

Download:
File-Find-Object-v0.3.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: v0.3.2   Source  

NAME ^

File::Find::Object::Result - a result class for File::Find::Object

VERSION ^

version v0.3.2

DESCRIPTION ^

This is a class returning a single File::Find::Object result as returned by its next_obj() method.

METHODS ^

File::Find::Object::Result->new({%args});

Initializes a new object from %args. For internal use.

$result->base()

Returns the base directory from which searching began.

$result->path()

Returns the full path of the result. As such $ffo->next_obj()->path() is equivalent to $ffo->next() .

$result->is_dir()

Returns true if the result refers to a directory.

$result->is_file()

Returns true if the result refers to a plain file (equivalent to the Perl -f operator).

$result->is_link()

Returns true if the result is a symbolic link.

$result->dir_components()

The components of the directory part of the path starting from base() (also the full path if the result is a directory) as an array reference.

$result->basename()

Returns the basename of the file (if it is a file and not a directory.) Otherwise - undef().

$result->full_components()

Returns the full components of the result with the basename if it is a file.

Returns a single array reference.

$result->stat_ret()

The return value of "stat" in perlfunc for the result, placed inside an array reference. This is calculated by File::Find::Object and kept here for convenience and for internal use.

SEE ALSO ^

File::Find::Object

LICENSE ^

Copyright (C) 2005, 2006 by Olivier Thauvin

This package is free software; you can redistribute it and/or modify it under the following terms:

1. The GNU General Public License Version 2.0 - http://www.opensource.org/licenses/gpl-license.php

2. The Artistic License Version 2.0 - http://www.perlfoundation.org/legal/licenses/artistic-2_0.html

3. At your option - any later version of either or both of these licenses.

AUTHOR ^

Shlomi Fish <shlomif@cpan.org>

COPYRIGHT AND LICENSE ^

This software is Copyright (c) 2000 by Olivier Thauvin and others.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)

BUGS ^

Please report any bugs or feature requests on the bugtracker website http://rt.cpan.org/NoAuth/Bugs.html?Dist=File-Find-Object or by email to bug-file-find-object@rt.cpan.org.

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SUPPORT ^

Perldoc

You can find documentation for this module with the perldoc command.

  perldoc File::Find::Object

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-file-find-object at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=File-Find-Object. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

http://bitbucket.org/shlomif/perl-file-find-object

  hg clone ssh://hg@bitbucket.org/shlomif/perl-file-find-object
syntax highlighting: