view release on metacpan or  search on metacpan

lib/FFI/Me.pm  view on Meta::CPAN

Default: The NAME passed to ffi().

=item * method

Boolean. If true, it will create the symbol as a method instead of a function.

Default: false

=back

=head2 Types

Each type has a function that will return the type suitable for “rv” and “arg”.

We use the ffi:: name space for these functions to avoid importing them while still keeping them short.

=head3 ffi::void

=head3 ffi::int

=head3 ffi::uint

=head3 ffi::short

=head3 ffi::ushort

=head3 ffi::long

=head3 ffi::ulong

=head3 ffi::int64

=head3 ffi::uint64

=head3 ffi::char

=head3 ffi::uchar

=head3 ffi::float

=head3 ffi::double

=head3 ffi::str

=head3 ffi::ptr

=head1 DIAGNOSTICS

Throws no warnings or errors of its own.

The underlying low-level library throws an exception when it can’t do what we’re asking it to.

=head1 DEPENDENCIES

L<FFI::Raw>

=head1 INCOMPATIBILITIES

None reported.

=head1 BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to
C<bug-ffi-me@rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org>.

=head1 TODO

Possibly some library lookup ability to allow for things like C<lib => 'libm'> witout needing to C<$^O eq 'darwin' ? 'libm.dylib' : 'libm.so'>.

=head1 AUTHOR

Daniel Muey  C<< <http://drmuey.com/cpan_contact.pl> >>

=head1 LICENCE AND COPYRIGHT

Copyright (c) 2015, Daniel Muey C<< <http://drmuey.com/cpan_contact.pl> >>. All rights reserved.

This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlartistic>.


=head1 DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.