Michał Wojciechowski > File-PlainPath-0.02 > File::PlainPath

Download:
File-PlainPath-0.02.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source   Latest Release: File-PlainPath-0.030

NAME ^

File::PlainPath - Construct portable filesystem paths in a simple way

VERSION ^

version 0.02

SYNOPSIS ^

    use File::PlainPath qw(path);
    
    # Forward slash is the default directory separator
    my $path = path 'dir/subdir/file.txt';
    
    # Set backslash as directory separator
    File::PlainPath::set_separator('\\');   
    my $other_path = path 'dir\\other_dir\\other_file.txt';

DESCRIPTION ^

File::PlainPath translates filesystem paths that use a common directory separator to OS-specific paths. It allows you to replace constructs like this:

    my $path = File::Spec->catfile('dir', 'subdir', 'file.txt');

with a simpler notation:

    my $path = path 'dir/subdir/file.txt';

The default directory separator used in paths is the forward slash (/), but any other character can be designated as the separator:

    File::PlainPath::set_separator(':');
    my $path = path 'dir:subdir:file.txt';

FUNCTIONS ^

path

Translates the provided path to OS-specific format. If more than one path is specified, the paths are concatenated to produce the resulting path.

Examples:

    my $path = path 'dir/file.txt';

    my $path = path 'dir', 'subdir/file.txt';
    # On Unix, this produces: "dir/subdir/file.txt" 

to_path

An alias for "path". Use it when there's another module that exports a subroutine named path (such as File::Spec::Functions).

Example:

    use File::PlainPath qw(to_path);
    
    my $path = to_path 'dir/file.txt';

set_separator

Sets the character to be used as directory separator.

Example:

    File::PlainPath::set_separator(':');

SEE ALSO ^

AUTHOR ^

Michal Wojciechowski <odyniec@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2012 by Michal Wojciechowski.

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

syntax highlighting: