Steven Haryanto > Setup-File-Symlink > Setup::File::Symlink

Download:
Setup-File-Symlink-0.26.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.26   Source  

NAME ^

Setup::File::Symlink - Setup symlink (existence, target)

VERSION ^

This document describes version 0.26 of Setup::File::Symlink (from Perl distribution Setup-File-Symlink), released on 2014-05-17.

FUNCTIONS ^

ln_s(%args) -> [status, msg, result, meta]

Create symlink.

Fixed state: symlink exists and points to target.

Fixable state: symlink doesn't exist.

This function is idempotent (repeated invocations with same arguments has the same effect as single invocation). This function supports transactions.

Arguments ('*' denotes required arguments):

Special arguments:

Return value:

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

rmsym(%args) -> [status, msg, result, meta]

Delete symlink.

Will not delete non-symlinks.

Fixed state: path doesn't exist.

Fixable state: path exists, is a symlink, (and if target is defined, points to target).

This function is idempotent (repeated invocations with same arguments has the same effect as single invocation). This function supports transactions.

Arguments ('*' denotes required arguments):

Special arguments:

Return value:

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

setup_symlink(%args) -> [status, msg, result, meta]

Setup symlink (existence, target).

When should_exist=1> (the default): On do, will create symlink which points to specified target. If symlink already exists but points to another target, it will be replaced with the correct symlink if replace_symlink option is true. If a file/dir already exists and replace_file/replace_dir option is true, it will be moved (trashed) first before the symlink is created. On undo, will delete symlink if it was created by this function, and restore the original symlink/file/dir if it was replaced during do.

When should_exist=0>: On do, will remove symlink if it exists (and replace_symlink is true). If replace_file/replace_dir is true, will also remove file/dir. On undo, will restore deleted symlink/file/dir.

This function is idempotent (repeated invocations with same arguments has the same effect as single invocation). This function supports transactions.

Arguments ('*' denotes required arguments):

Special arguments:

Return value:

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

SEE ALSO ^

Setup

Setup::File

HOMEPAGE ^

Please visit the project's homepage at https://metacpan.org/release/Setup-File-Symlink.

SOURCE ^

Source repository is at https://github.com/sharyanto/perl-Setup-File-Symlink.

BUGS ^

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Setup-File-Symlink

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.

AUTHOR ^

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 by Steven Haryanto.

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: