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

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

NAME

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

VERSION

9       version 0.3.7
10

DESCRIPTION

12       This is a class returning a single File::Find::Object result as
13       returned by its next_obj() method.
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       •   RT: CPAN's Bug Tracker
88
89           The RT ( Request Tracker ) website is the default bug/issue
90           tracking system for CPAN.
91
92           <https://rt.cpan.org/Public/Dist/Display.html?Name=File-Find-Object>
93
94       •   CPANTS
95
96           The CPANTS is a website that analyzes the Kwalitee ( code metrics )
97           of a distribution.
98
99           <http://cpants.cpanauthors.org/dist/File-Find-Object>
100
101       •   CPAN Testers
102
103           The CPAN Testers is a network of smoke testers who run automated
104           tests on uploaded CPAN distributions.
105
106           <http://www.cpantesters.org/distro/F/File-Find-Object>
107
108       •   CPAN Testers Matrix
109
110           The CPAN Testers Matrix is a website that provides a visual
111           overview of the test results for a distribution on various
112           Perls/platforms.
113
114           <http://matrix.cpantesters.org/?dist=File-Find-Object>
115
116       •   CPAN Testers Dependencies
117
118           The CPAN Testers Dependencies is a website that shows a chart of
119           the test results of all dependencies for a distribution.
120
121           <http://deps.cpantesters.org/?module=File::Find::Object>
122
123   Bugs / Feature Requests
124       Please report any bugs or feature requests by email to
125       "bug-file-find-object at rt.cpan.org", or through the web interface at
126       <https://rt.cpan.org/Public/Bug/Report.html?Queue=File-Find-Object>.
127       You will be automatically notified of any progress on the request by
128       the system.
129
130   Source Code
131       The code is open to the world, and available for you to hack on. Please
132       feel free to browse it and play with it, or whatever. If you want to
133       contribute patches, please send me a diff or prod me to pull from your
134       repository :)
135
136       <https://github.com/shlomif/perl-file-find-object>
137
138         git clone git://github.com/shlomif/perl-file-find-object.git
139

AUTHOR

141       Shlomi Fish <shlomif@cpan.org>
142

BUGS

144       Please report any bugs or feature requests on the bugtracker website
145       <https://github.com/shlomif/perl-file-find-object/issues>
146
147       When submitting a bug or request, please include a test-file or a patch
148       to an existing test-file that illustrates the bug or desired feature.
149

COPYRIGHT AND LICENSE

151       This software is Copyright (c) 2000 by Olivier Thauvin and others.
152
153       This is free software, licensed under:
154
155         The Artistic License 2.0 (GPL Compatible)
156
157
158
159perl v5.36.0                      2023-01-20     File::Find::Object::Result(3)