/ 
App-CreateRandomFile-0.02
River stage one • 1 direct dependent • 1 total dependent
/ App::CreateRandomFile

NAME

App::CreateRandomFile - Create random file

VERSION

This document describes version 0.02 of App::CreateRandomFile (from Perl distribution App-CreateRandomFile), released on 2017-03-21.

SYNOPSIS

See create-random-file.

FUNCTIONS

create_random_file

Usage:

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

Create random file.

Examples:

  • Create a file of size 1MB containing random bytes:

    create_random_file( name => "file1", size => "1M");

  • Like the previous example (--random-bytes is optional):

    create_random_file( name => "file2", size => "2M", random_bytes => 1);

  • Create a file of size 3.5KB containing repeated pattern:

    create_random_file( name => "file3", size => "3.5K", patterns => ["AABBCC"]);

  • Create a file of size 4KB containing random sequences of A, B, C:

    create_random_file( name => "file4", size => "4K", patterns => ["A", "B", "C"]);

Create "random" file with a specified size. There are several choices of what random data to use:

  • random bytes, created using rand()

  • repeated pattern supplied from --pattern command-line option

TODO:

  • random bytes, source from /dev/urandom

  • random lines from a specified file

  • random byte sequences from a specified file

This function is not exported.

Arguments ('*' denotes required arguments):

  • interactive => bool (default: 0)

    Whether or not the program should be interactive.

    If set to false then will not prompt interactively and usually will proceed (unless for dangerous stuffs, in which case will bail immediately.

  • name* => str

  • overwrite => bool (default: 0)

    Whether to overwrite existing file.

    If se to true then will overwrite existing file without warning. The default is to prompt, or bail (if not interactive).

  • patterns => array[str]

  • random_bytes => bool

  • size* => str

    Size (e.g. 10K, 22.5M).

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.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-CreateRandomFile.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-CreateRandomFile.

BUGS

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

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

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017, 2015 by perlancar@cpan.org.

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