--- /dev/null
+.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
+.\"
+.\" 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" ''
+'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 (.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.
+.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 "MooseX::Clone 3"
+.TH MooseX::Clone 3 "2010-01-13" "perl v5.8.8" "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"
+MooseX::Clone \- Fine grained cloning support for Moose objects.
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 2
+\& package Bar;
+\& use Moose;
+\&
+\& with qw(MooseX::Clone);
+\&
+\& has foo => (
+\& isa => "Foo",
+\& traits => [qw(Clone)], # this attribute will be recursively cloned
+\& );
+\&
+\& package Foo;
+\& use Moose;
+\&
+\& # this API is used/provided by MooseX::Clone
+\& sub clone {
+\& my ( $self, %params ) = @_;
+\&
+\& # ...
+\& }
+\&
+\&
+\& # used like this:
+\&
+\& my $bar = Bar\->new( foo => Foo\->new );
+\&
+\& my $copy = $bar\->clone( foo => [ qw(Args for Foo::clone) ] );
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+Out of the box Moose only provides very barebones cloning support in order
+to maximize flexibility.
+.PP
+This role provides a \f(CW\*(C`clone\*(C'\fR method that makes use of the low level cloning
+support already in Moose and adds selective deep cloning based on
+introspection on top of that. Attributes with the \f(CW\*(C`Clone\*(C'\fR trait will handle
+cloning of data within the object, typically delegating to the attribute
+value's own \f(CW\*(C`clone\*(C'\fR method.
+.SH "TRAITS"
+.IX Header "TRAITS"
+.IP "Clone" 4
+.IX Item "Clone"
+By default Moose objects are cloned like this:
+.Sp
+.Vb 1
+\& bless { %$old }, ref $old;
+.Ve
+.Sp
+By specifying the Clone trait for certain attributes custom behavior the
+value's own \f(CW\*(C`clone\*(C'\fR method will be invoked.
+.Sp
+By extending this trait you can create custom cloning for certain attributes.
+.Sp
+By creating \f(CW\*(C`clone\*(C'\fR methods for your objects (e.g. by composing
+MooseX::Compile) you can make them interact with this trait.
+.IP "NoClone" 4
+.IX Item "NoClone"
+Specifies attributes that should be skipped entirely while cloning.
+.SH "METHODS"
+.IX Header "METHODS"
+.ie n .IP "clone %params" 4
+.el .IP "clone \f(CW%params\fR" 4
+.IX Item "clone %params"
+Returns a clone of the object.
+.Sp
+All attributes which do the MooseX::Clone::Meta::Attribute::Trait::Clone
+role will handle cloning of that attribute. All other fields are plainly copied
+over, just like in \*(L"clone_object\*(R" in Class::MOP::Class.
+.Sp
+Attributes whose \f(CW\*(C`init_arg\*(C'\fR is in \f(CW%params\fR and who do the \f(CW\*(C`Clone\*(C'\fR trait will
+get that argument passed to the \f(CW\*(C`clone\*(C'\fR method (dereferenced). If the
+attribute does not self-clone then the param is used normally by
+\&\*(L"clone_object\*(R" in Class::MOP::Class, that is it will simply shadow the previous
+value, and does not have to be an array or hash reference.
+.SH "TODO"
+.IX Header "TODO"
+Refactor to work in term of a metaclass trait so that \f(CW\*(C`meta\->clone_object\*(C'\fR
+will still do the right thing.
+.SH "THANKS"
+.IX Header "THANKS"
+clkao made the food required to write this module
+.SH "VERSION CONTROL"
+.IX Header "VERSION CONTROL"
+<http://code2.0beta.co.uk/moose/svn/>. Ask on #moose for commit bits.
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Yuval Kogman <nothingmuch@woobling.org>
+.SH "COPYRIGHT"
+.IX Header "COPYRIGHT"
+.Vb 3
+\& Copyright (c) 2008 Yuval Kogman. All rights reserved
+\& This program is free software; you can redistribute
+\& it and/or modify it under the same terms as Perl itself.
+.Ve
projects / catagits/Gitalist.git / blobdiff