.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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::C::StructDef 3pm"
.TH FFI::C::StructDef 3pm "2023-02-06" "perl v5.36.0" "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::C::StructDef \- Structured data definition for FFI
.SH "VERSION"
.IX Header "VERSION"
version 0.15
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In your C code:
.PP
.Vb 2
\& #include <stdint.h>
\& #include <stdio.h>
\& 
\& typedef struct {
\&   uint8_t red;
\&   uint8_t green;
\&   uint8_t blue;
\& } color_t;
\& 
\& void
\& print_color(color_t *c)
\& {
\&   printf("[%02x %02x %02x]\en",
\&     c\->red,
\&     c\->green,
\&     c\->blue
\&   );
\& }
.Ve
.PP
In your Perl code:
.PP
.Vb 2
\& use FFI::Platypus 1.00;
\& use FFI::C::StructDef;
\& 
\& my $ffi = FFI::Platypus\->new( api => 1 );
\& # See FFI::Platypus::Bundle for how bundle works.
\& $ffi\->bundle;
\& 
\& my $def = FFI::C::StructDef\->new(
\&   $ffi,
\&   name  => \*(Aqcolor_t\*(Aq,
\&   class => \*(AqColor\*(Aq,
\&   members => [
\&     red   => \*(Aquint8\*(Aq,
\&     green => \*(Aquint8\*(Aq,
\&     blue  => \*(Aquint8\*(Aq,
\&   ],
\& );
\& 
\& my $red = Color\->new({ red => 255 });
\& 
\& my $green = Color\->new({ green => 255 });
\& 
\& $ffi\->attach( print_color => [\*(Aqcolor_t\*(Aq] );
\& 
\& print_color($red);   # [ff 00 00]
\& print_color($green); # [00 ff 00]
\& 
\& # that red is a tad bright!
\& $red\->red( 200 );
\& 
\& print_color($red);   # [c8 00 00]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class creates a def for a C \f(CW\*(C`struct\*(C'\fR.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.SS "new"
.IX Subsection "new"
.Vb 2
\& my $def = FFI::C::StructDef\->new(%opts);
\& my $def = FFI::C::StructDef\->new($ffi, %opts);
.Ve
.PP
For standard def options, see FFI::C::Def.
.IP "members" 4
.IX Item "members"
This should be an array reference containing name, type pairs,
in the order that they will be stored in the struct.
.IP "trim_string" 4
.IX Item "trim_string"
If true, fixed-length strings should be treated as null terminated
strings and be trimmed.
.SH "METHODS"
.IX Header "METHODS"
.SS "create"
.IX Subsection "create"
.Vb 4
\& my $instance = $def\->create;
\& my $instance = $def\->class\->new;          # if class was specified
\& my $instance = $def\->create(\e%init);
\& my $instance = $def\->class\->new(\e%init);  # if class was specified
.Ve
.PP
This creates an instance of the \f(CW\*(C`struct\*(C'\fR, returns a FFI::C::Struct.
.PP
You can optionally initialize member values using \f(CW%init\fR.
.SS "trim_string"
.IX Subsection "trim_string"
.Vb 1
\& my $bool = $def\->trim_string;
.Ve
.PP
Returns true if fixed-length strings should be treated as null terminated
strings and be trimmed.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\s-1FFI::C\s0" 4
.IX Item "FFI::C"
.PD 0
.IP "FFI::C::Array" 4
.IX Item "FFI::C::Array"
.IP "FFI::C::ArrayDef" 4
.IX Item "FFI::C::ArrayDef"
.IP "FFI::C::Def" 4
.IX Item "FFI::C::Def"
.IP "FFI::C::File" 4
.IX Item "FFI::C::File"
.IP "FFI::C::PosixFile" 4
.IX Item "FFI::C::PosixFile"
.IP "FFI::C::Struct" 4
.IX Item "FFI::C::Struct"
.IP "FFI::C::StructDef" 4
.IX Item "FFI::C::StructDef"
.IP "FFI::C::Union" 4
.IX Item "FFI::C::Union"
.IP "FFI::C::UnionDef" 4
.IX Item "FFI::C::UnionDef"
.IP "FFI::C::Util" 4
.IX Item "FFI::C::Util"
.IP "FFI::Platypus::Record" 4
.IX Item "FFI::Platypus::Record"
.PD
.SH "AUTHOR"
.IX Header "AUTHOR"
Graham Ollis <plicease@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2020\-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.