NAME

       FFI::Platypus::Type::PointerSizeBuffer - Convert string scalar to a buffer as a pointer /
       size_t combination

VERSION

       version 2.00

SYNOPSIS

       In your C code:

        void
        function_with_buffer(void *pointer, size_t size)
        {
          ...
        }

       In your Platypus::FFI code:

        use FFI::Platypus 2.00;

        my $ffi = FFI::Platypus->new( api => 2 );
        $ffi->load_custom_type('::PointerSizeBuffer' => 'buffer');

        $ffi->attach(function_with_buffer => ['buffer'] => 'void');
        my $string = "content of buffer";
        function_with_buffer($string);

DESCRIPTION

       A common pattern in C code is to pass in a region of memory as a buffer, consisting of a
       pointer and a size of the memory region.  In Perl, string scalars also point to a
       contiguous series of bytes that has a size, so when interfacing with C libraries it is
       handy to be able to pass in a string scalar as a pointer / size buffer pair.

SEE ALSO

       FFI::Platypus
           Main Platypus documentation.

       FFI::Platypus::Type
           Platypus types documentation.

AUTHOR

       Author: Graham Ollis <plicease@cpan.org>

       Contributors:

       Bakkiaraj Murugesan (bakkiaraj)

       Dylan Cali (calid)

       pipcet

       Zaki Mughal (zmughal)

       Fitz Elliott (felliott)

       Vickenty Fesunov (vyf)

       Gregor Herrmann (gregoa)

       Shlomi Fish (shlomif)

       Damyan Ivanov

       Ilya Pavlov (Ilya33)

       Petr Písař (ppisar)

       Mohammad S Anwar (MANWAR)

       Håkon Hægland (hakonhagland, HAKONH)

       Meredith (merrilymeredith, MHOWARD)

       Diab Jerius (DJERIUS)

       Eric Brine (IKEGAMI)

       szTheory

       José Joaquín Atria (JJATRIA)

       Pete Houston (openstrike, HOUSTON)

COPYRIGHT AND LICENSE

       This software is copyright (c) 2015-2022 by Graham Ollis.

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