📄 class::struct.3
字号:
.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05).\".\" Standard preamble:.\" ========================================================================.de Sh \" Subsection heading.br.if t .Sp.ne 5.PP\fB\\$1\fR.PP...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" '''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 turned on, we'll generate index entries on stderr for.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index.\" entries marked with X<> in POD. Of course, you'll have to process the.\" output yourself in some meaningful fashion..ie \nF \{\. de IX. tm Index:\\$1\t\\n%\t"\\$2"... nr % 0. rr F.\}.el \{\. de IX...\}.\".\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2)..\" Fear. Run. Save yourself. No user-serviceable parts.. \" fudge factors for nroff and troff.if n \{\. ds #H 0. ds #V .8m. ds #F .3m. ds #[ \f1. ds #] \fP.\}.if t \{\. ds #H ((1u-(\\\\n(.fu%2u))*.13m). ds #V .6m. ds #F 0. ds #[ \&. ds #] \&.\}. \" simple accents for nroff and troff.if n \{\. ds ' \&. ds ` \&. ds ^ \&. ds , \&. ds ~ ~. ds /.\}.if t \{\. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u". ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'.\}. \" troff and (daisy-wheel) nroff accents.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'.ds 8 \h'\*(#H'\(*b\h'-\*(#H'.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#].ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#].ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#].ds ae a\h'-(\w'a'u*4/10)'e.ds Ae A\h'-(\w'A'u*4/10)'E. \" corrections for vroff.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'. \" for low resolution devices (crt and lpr).if \n(.H>23 .if \n(.V>19 \\{\. ds : e. ds 8 ss. ds o a. ds d- d\h'-1'\(ga. ds D- D\h'-1'\(hy. ds th \o'bp'. ds Th \o'LP'. ds ae ae. ds Ae AE.\}.rm #[ #] #H #V #F C.\" ========================================================================.\".IX Title "Class::Struct 3".TH Class::Struct 3 "2007-12-18" "perl v5.10.0" "Perl Programmers Reference Guide".\" 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"Class::Struct \- declare struct\-like datatypes as Perl classes.SH "SYNOPSIS".IX Header "SYNOPSIS".Vb 5\& use Class::Struct;\& # declare struct, based on array:\& struct( CLASS_NAME => [ ELEMENT_NAME => ELEMENT_TYPE, ... ]);\& # declare struct, based on hash:\& struct( CLASS_NAME => { ELEMENT_NAME => ELEMENT_TYPE, ... });\&\& package CLASS_NAME;\& use Class::Struct;\& # declare struct, based on array, implicit class name:\& struct( ELEMENT_NAME => ELEMENT_TYPE, ... );\&\& # Declare struct at compile time\& use Class::Struct CLASS_NAME => [ ELEMENT_NAME => ELEMENT_TYPE, ... ];\& use Class::Struct CLASS_NAME => { ELEMENT_NAME => ELEMENT_TYPE, ... };\&\& # declare struct at compile time, based on array, implicit class name:\& package CLASS_NAME;\& use Class::Struct ELEMENT_NAME => ELEMENT_TYPE, ... ;\&\& package Myobj;\& use Class::Struct;\& # declare struct with four types of elements:\& struct( s => \*(Aq$\*(Aq, a => \*(Aq@\*(Aq, h => \*(Aq%\*(Aq, c => \*(AqMy_Other_Class\*(Aq );\&\& $obj = new Myobj; # constructor\&\& # scalar type accessor:\& $element_value = $obj\->s; # element value\& $obj\->s(\*(Aqnew value\*(Aq); # assign to element\&\& # array type accessor:\& $ary_ref = $obj\->a; # reference to whole array\& $ary_element_value = $obj\->a(2); # array element value\& $obj\->a(2, \*(Aqnew value\*(Aq); # assign to array element\&\& # hash type accessor:\& $hash_ref = $obj\->h; # reference to whole hash\& $hash_element_value = $obj\->h(\*(Aqx\*(Aq); # hash element value\& $obj\->h(\*(Aqx\*(Aq, \*(Aqnew value\*(Aq); # assign to hash element\&\& # class type accessor:\& $element_value = $obj\->c; # object reference\& $obj\->c\->method(...); # call method of object\& $obj\->c(new My_Other_Class); # assign a new object.Ve.SH "DESCRIPTION".IX Header "DESCRIPTION"\&\f(CW\*(C`Class::Struct\*(C'\fR exports a single function, \f(CW\*(C`struct\*(C'\fR.Given a list of element names and types, and optionallya class name, \f(CW\*(C`struct\*(C'\fR creates a Perl 5 class that implementsa \*(L"struct-like\*(R" data structure..PPThe new class is given a constructor method, \f(CW\*(C`new\*(C'\fR, for creatingstruct objects..PPEach element in the struct data has an accessor method, which isused to assign to the element and to fetch its value. Thedefault accessor can be overridden by declaring a \f(CW\*(C`sub\*(C'\fR of thesame name in the package. (See Example 2.).PPEach element's type can be scalar, array, hash, or class..ie n .Sh "The ""struct()"" function".el .Sh "The \f(CWstruct()\fP function".IX Subsection "The struct() function"The \f(CW\*(C`struct\*(C'\fR function has three forms of parameter-list..PP.Vb 3\& struct( CLASS_NAME => [ ELEMENT_LIST ]);\& struct( CLASS_NAME => { ELEMENT_LIST });\& struct( ELEMENT_LIST );.Ve.PPThe first and second forms explicitly identify the name of theclass being created. The third form assumes the current packagename as the class name..PPAn object of a class created by the first and third forms isbased on an array, whereas an object of a class created by thesecond form is based on a hash. The array-based forms will besomewhat faster and smaller; the hash-based forms are moreflexible..PPThe class created by \f(CW\*(C`struct\*(C'\fR must not be a subclass of anotherclass other than \f(CW\*(C`UNIVERSAL\*(C'\fR..PPIt can, however, be used as a superclass for other classes. To facilitatethis, the generated constructor method uses a two-argument blessing.Furthermore, if the class is hash-based, the key of each element isprefixed with the class name (see \fIPerl Cookbook\fR, Recipe 13.12)..PPA function named \f(CW\*(C`new\*(C'\fR must not be explicitly defined in a classcreated by \f(CW\*(C`struct\*(C'\fR..PPThe \fI\s-1ELEMENT_LIST\s0\fR has the form.PP.Vb 1\& NAME => TYPE, ....Ve.PPEach name-type pair declares one element of the struct. Eachelement name will be defined as an accessor method unless amethod by that name is explicitly defined; in the latter case, awarning is issued if the warning flag (\fB\-w\fR) is set..Sh "Class Creation at Compile Time".IX Subsection "Class Creation at Compile Time"\&\f(CW\*(C`Class::Struct\*(C'\fR can create your class at compile time. The main reasonfor doing this is obvious, so your class acts like every other class inPerl. Creating your class at compile time will make the order of eventssimilar to using any other class ( or Perl module )..PPThere is no significant speed gain between compile time and run timeclass creation, there is just a new, more standard order of events..Sh "Element Types and Accessor Methods".IX Subsection "Element Types and Accessor Methods"The four element types \*(-- scalar, array, hash, and class \*(-- arerepresented by strings \*(-- \f(CW\*(Aq$\*(Aq\fR, \f(CW\*(Aq@\*(Aq\fR, \f(CW\*(Aq%\*(Aq\fR, and a class name \*(--optionally preceded by a \f(CW\*(Aq*\*(Aq\fR..PPThe accessor method provided by \f(CW\*(C`struct\*(C'\fR for an element dependson the declared type of the element..ie n .IP "Scalar (\*(Aq$\*(Aq\fR or \f(CW\*(Aq*$\*(Aq)" 4.el .IP "Scalar (\f(CW\*(Aq$\*(Aq\fR or \f(CW\*(Aq*$\*(Aq\fR)" 4
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -