NAME

Sys::LoopDevice - Routines to manipulate loop(back) device in a cross-platform way

VERSION

This document describes version 0.003 of Sys::LoopDevice (from Perl distribution Sys-LoopDevice), released on 2016-12-28.

SYNOPSIS

use Sys::LoopDevice qw(
    list_attached_loop_devices
    list_detached_loop_devices
    attach_loop_devices
    detach_loop_devices
);

DESCRIPTION

STATUS: Early release, API might still change significantly and only Linux support has been implemented.

TODO: Support other OS'es

TODO: Support ro option when attaching

FUNCTIONS

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

Attach a file to a loop device.

This function is not exported.

Arguments ('*' denotes required arguments):

  • device => str

  • filename* => filename

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)

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

Attach a file to a loop device.

This function is not exported.

Arguments ('*' denotes required arguments):

  • device => str

  • filename => filename

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)

list_attached_loop_devices() -> [status, msg, result, meta]

List attached loop devices.

This function is not exported.

No arguments.

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/Sys-LoopDevice.

SOURCE

Source repository is at https://github.com/perlancar/perl-Sys-LoopDevice.

BUGS

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

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) 2016 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.