.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "FFI::Platypus::Record::TieArray 3pm"
.TH FFI::Platypus::Record::TieArray 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
FFI::Platypus::Record::TieArray \- Tied array interface for record array members
.SH VERSION
.IX Header "VERSION"
version 2.08
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& package Foo;
\& 
\& use FFI::Platypus::Record;
\& use FFI::Platypus::Record::TieArray;
\& 
\& record_layout(qw(
\&   int[20]  _bar
\& ));
\& 
\& sub bar
\& {
\&   my($self, $arg) = @_;
\&   $self\->_bar($arg) if ref($arg) eq \*(Aq ARRAY\*(Aq;
\&   tie my @list, \*(AqFFI::Platypus::Record::TieArray\*(Aq,
\&     $self, \*(Aq_bar\*(Aq, 20;
\& }
\& 
\& package main;
\& 
\& my $foo = Foo\->new;
\& 
\& my $bar5 = $foo\->bar\->[5];  # get the 5th element of the bar array
\& $foo\->bar\->[5] = 10;        # set the 5th element of the bar array
\& @{ $foo\->bar } = ();        # set all elements in bar to 0
\& @{ $foo\->bar } = (1..5);    # set the first five elements of the bar array
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBWARNING\fR: This module is considered EXPERIMENTAL.  It may go away or
be changed in incompatible ways, possibly without notice, but not
without a good reason.
.PP
This class provides a tie interface for record array members.
.PP
In the future a short cut for using this with FFI::Platypus::Record
directly may be provided.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP FFI::Platypus 4
.IX Item "FFI::Platypus"
The main Platypus documentation.
.IP FFI::Platypus::Record 4
.IX Item "FFI::Platypus::Record"
Documentation on Platypus records.
.SH AUTHOR
.IX Header "AUTHOR"
Author: Graham Ollis <plicease@cpan.org>
.PP
Contributors:
.PP
Bakkiaraj Murugesan (bakkiaraj)
.PP
Dylan Cali (calid)
.PP
pipcet
.PP
Zaki Mughal (zmughal)
.PP
Fitz Elliott (felliott)
.PP
Vickenty Fesunov (vyf)
.PP
Gregor Herrmann (gregoa)
.PP
Shlomi Fish (shlomif)
.PP
Damyan Ivanov
.PP
Ilya Pavlov (Ilya33)
.PP
Petr Písař (ppisar)
.PP
Mohammad S Anwar (MANWAR)
.PP
Håkon Hægland (hakonhagland, HAKONH)
.PP
Meredith (merrilymeredith, MHOWARD)
.PP
Diab Jerius (DJERIUS)
.PP
Eric Brine (IKEGAMI)
.PP
szTheory
.PP
José Joaquín Atria (JJATRIA)
.PP
Pete Houston (openstrike, HOUSTON)
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2015\-2022 by Graham Ollis.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.