File::Find::Object::Result(3pm)

1File::Find::Object::ResUusletr(3C)ontributed Perl DocumeFnitlaet:i:oFnind::Object::Result(3)
2
3
4

VERSION

6       version 0.3.4
7

DESCRIPTION

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

NAME

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

METHODS

16   File::Find::Object::Result->new({%args});
17       Initializes a new object from %args. For internal use.
18
19   $result->base()
20       Returns the base directory from which searching began.
21
22   $result->path()
23       Returns the full path of the result. As such "$ffo->next_obj()->path()"
24       is equivalent to "$ffo->next()" .
25
26   $result->is_dir()
27       Returns true if the result refers to a directory.
28
29   $result->is_file()
30       Returns true if the result refers to a plain file (equivalent to the
31       Perl "-f" operator).
32
33   $result->is_link()
34       Returns true if the result is a symbolic link.
35
36   $result->dir_components()
37       The components of the directory part of the path starting from base()
38       (also the full path if the result is a directory) as an array
39       reference.
40
41   $result->basename()
42       Returns the basename of the file (if it is a file and not a directory.)
43       Otherwise - undef().
44
45   $result->full_components()
46       Returns the full components of the result with the basename if it is a
47       file.
48
49       Returns a single array reference.
50
51   $result->stat_ret()
52       The return value of "stat" in perlfunc for the result, placed inside an
53       array reference. This is calculated by File::Find::Object and kept here
54       for convenience and for internal use.
55

LICENSE

60       Copyright (C) 2005, 2006 by Olivier Thauvin
61
62       This package is free software; you can redistribute it and/or modify it
63       under the following terms:
64
65       1. The GNU General Public License Version 2.0 -
66       http://www.opensource.org/licenses/gpl-license.php
67
68       2. The Artistic License Version 2.0 -
69       http://www.perlfoundation.org/legal/licenses/artistic-2_0.html
70
71       3. At your option - any later version of either or both of these
72       licenses.
73

SUPPORT

75   Websites
76       The following websites have more information about this module, and may
77       be of help to you. As always, in addition to those websites please use
78       your favorite search engine to discover more resources.
79
80       ·   MetaCPAN
81
82           A modern, open-source CPAN search engine, useful to view POD in
83           HTML format.
84
85           <https://metacpan.org/release/File-Find-Object>
86
87       ·   Search CPAN
88
89           The default CPAN search engine, useful to view POD in HTML format.
90
91           <http://search.cpan.org/dist/File-Find-Object>
92
93       ·   RT: CPAN's Bug Tracker
94
95           The RT ( Request Tracker ) website is the default bug/issue
96           tracking system for CPAN.
97
98           <https://rt.cpan.org/Public/Dist/Display.html?Name=File-Find-Object>
99
100       ·   AnnoCPAN
101
102           The AnnoCPAN is a website that allows community annotations of Perl
103           module documentation.
104
105           <http://annocpan.org/dist/File-Find-Object>
106
107       ·   CPAN Ratings
108
109           The CPAN Ratings is a website that allows community ratings and
110           reviews of Perl modules.
111
112           <http://cpanratings.perl.org/d/File-Find-Object>
113
114       ·   CPANTS
115
116           The CPANTS is a website that analyzes the Kwalitee ( code metrics )
117           of a distribution.
118
119           <http://cpants.cpanauthors.org/dist/File-Find-Object>
120
121       ·   CPAN Testers
122
123           The CPAN Testers is a network of smoke testers who run automated
124           tests on uploaded CPAN distributions.
125
126           <http://www.cpantesters.org/distro/F/File-Find-Object>
127
128       ·   CPAN Testers Matrix
129
130           The CPAN Testers Matrix is a website that provides a visual
131           overview of the test results for a distribution on various
132           Perls/platforms.
133
134           <http://matrix.cpantesters.org/?dist=File-Find-Object>
135
136       ·   CPAN Testers Dependencies
137
138           The CPAN Testers Dependencies is a website that shows a chart of
139           the test results of all dependencies for a distribution.
140
141           <http://deps.cpantesters.org/?module=File::Find::Object>
142
143   Bugs / Feature Requests
144       Please report any bugs or feature requests by email to
145       "bug-file-find-object at rt.cpan.org", or through the web interface at
146       <https://rt.cpan.org/Public/Bug/Report.html?Queue=File-Find-Object>.
147       You will be automatically notified of any progress on the request by
148       the system.
149
150   Source Code
151       The code is open to the world, and available for you to hack on. Please
152       feel free to browse it and play with it, or whatever. If you want to
153       contribute patches, please send me a diff or prod me to pull from your
154       repository :)
155
156       <https://github.com/shlomif/perl-file-find-object>
157
158         git clone git://github.com/shlomif/perl-file-find-object.git
159

AUTHOR

161       Shlomi Fish <shlomif@cpan.org>
162

BUGS

164       Please report any bugs or feature requests on the bugtracker website
165       <https://github.com/shlomif/perl-file-find-object/issues>
166
167       When submitting a bug or request, please include a test-file or a patch
168       to an existing test-file that illustrates the bug or desired feature.
169

COPYRIGHT AND LICENSE

171       This software is Copyright (c) 2000 by Olivier Thauvin and others.
172
173       This is free software, licensed under:
174
175         The Artistic License 2.0 (GPL Compatible)
176
177
178
179perl v5.30.0                      2019-08-26     File::Find::Object::Result(3)