<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">NAME
    Setup::File::TextFragment - Insert/delete text fragment in a file, with
    undo support

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

FUNCTIONS
  setup_text_fragment(%args) -&gt; [status, msg, result, meta]
    Insert/delete text fragment in a file.

    On do, will insert fragment to file (or delete, if "should_exist" is set
    to false). On undo, will restore old file.

    Unfixable state: file does not exist or not a regular file (directory
    and symlink included).

    Fixed state: file exists, fragment already exists and with the same
    content (if "should_exist" is true) or fragment already does not exist
    (if "should_exist" is false).

    Fixable state: file exists, fragment doesn't exist or payload is not the
    same (if "should_exist" is true) or fragment still exists (if
    "should_exist" is false).

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

    Arguments ('*' denotes required arguments):

    *   attrs =&gt; *hash*

        Fragment attributes (only for inserting new fragment), passed to
        Text::Fragment.

    *   comment_style =&gt; *bool*

        Will be passed to Text::Fragment.

    *   good_pattern =&gt; *str*

        Will be passed to Text::Fragment.

    *   id* =&gt; *str*

        Fragment ID.

    *   label =&gt; *str*

        Will be passed to Text::Fragment.

    *   path* =&gt; *str*

        Path to file.

    *   payload* =&gt; *str*

        Fragment content.

    *   replace_pattern =&gt; *str*

        Will be passed to Text::Fragment.

    *   should_exist =&gt; *bool* (default: 1)

        Whether fragment should exist.

    *   top_style =&gt; *bool*

        Will be passed to Text::Fragment.

    Special arguments:

    *   -tx_action =&gt; *str*

        For more information on transaction, see Rinci::Transaction.

    *   -tx_action_id =&gt; *str*

        For more information on transaction, see Rinci::Transaction.

    *   -tx_recovery =&gt; *str*

        For more information on transaction, see Rinci::Transaction.

    *   -tx_rollback =&gt; *str*

        For more information on transaction, see Rinci::Transaction.

    *   -tx_v =&gt; *str*

        For more information on transaction, see Rinci::Transaction.

    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
    Text::Fragment

    Setup

HOMEPAGE
    Please visit the project's homepage at
    &lt;https://metacpan.org/release/Setup-File-TextFragment&gt;.

SOURCE
    Source repository is at
    &lt;https://github.com/sharyanto/perl-Setup-File-TextFragment&gt;.

BUGS
    Please report any bugs or feature requests on the bugtracker website
    &lt;https://rt.cpan.org/Public/Dist/Display.html?Name=Setup-File-TextFragme
    nt&gt;

    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 &lt;stevenharyanto@gmail.com&gt;

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.

</pre></body></html>