.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "SVN::Dump::Record 3pm"
.TH SVN::Dump::Record 3pm "2022-10-14" "perl v5.34.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"
SVN::Dump::Record \- A SVN dump record
.SH "VERSION"
.IX Header "VERSION"
version 0.08
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    # SVN::Dump::Record objects are returned by the next_record()
\&    # method of SVN::Dump
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
An SVN::Dump::Record object represents a Subversion dump record.
.SH "METHODS"
.IX Header "METHODS"
SVN::Dump provides the following gourps of methods:
.SS "Record methods"
.IX Subsection "Record methods"
.IP "\fBnew()\fR" 4
.IX Item "new()"
Create a new empty SVN::Dump::Record object.
.IP "\fBtype()\fR" 4
.IX Item "type()"
Return the record type, as guessed from its headers.
.Sp
The method dies if the record type cannot be determined.
.ie n .IP "set_header( $h, $v )" 4
.el .IP "set_header( \f(CW$h\fR, \f(CW$v\fR )" 4
.IX Item "set_header( $h, $v )"
Set the header \f(CW$h\fR to the value \f(CW$v\fR.
.ie n .IP "get_header( $h )" 4
.el .IP "get_header( \f(CW$h\fR )" 4
.IX Item "get_header( $h )"
Get the value of header \f(CW$h\fR.
.ie n .IP "set_property( $p, $v )" 4
.el .IP "set_property( \f(CW$p\fR, \f(CW$v\fR )" 4
.IX Item "set_property( $p, $v )"
Set the property \f(CW$p\fR to the value \f(CW$v\fR.
.ie n .IP "get_property( $p )" 4
.el .IP "get_property( \f(CW$p\fR )" 4
.IX Item "get_property( $p )"
Get the value of property \f(CW$p\fR.
.ie n .IP "delete_property( @k )" 4
.el .IP "delete_property( \f(CW@k\fR )" 4
.IX Item "delete_property( @k )"
Delete the properties named in \f(CW@p\fR. Properties
that do not exist in the record will be silently ignored.
.ie n .IP "set_text( $t )" 4
.el .IP "set_text( \f(CW$t\fR )" 4
.IX Item "set_text( $t )"
Set the value of the text block.
.IP "\fBget_text()\fR" 4
.IX Item "get_text()"
Get the value of the text block.
.SS "Inner blocks manipulation"
.IX Subsection "Inner blocks manipulation"
A SVN::Dump::Record is composed of several inner blocks of various kinds:
SVN::Dump::Headers, SVN::Dump::Property and SVN::Dump::Text.
.PP
The following methods provide access to these blocks:
.ie n .IP "set_headers_block( $headers )" 4
.el .IP "set_headers_block( \f(CW$headers\fR )" 4
.IX Item "set_headers_block( $headers )"
.PD 0
.IP "\fBget_headers_block()\fR" 4
.IX Item "get_headers_block()"
.PD
Get or set the SVN::Dump::Headers object that represents the record
headers.
.ie n .IP "set_property_block( $property )" 4
.el .IP "set_property_block( \f(CW$property\fR )" 4
.IX Item "set_property_block( $property )"
.PD 0
.IP "\fBget_property_block()\fR" 4
.IX Item "get_property_block()"
.PD
Get or set the SVN::Dump::Property object that represents the record
property block.
.ie n .IP "delete_property( @keys )" 4
.el .IP "delete_property( \f(CW@keys\fR )" 4
.IX Item "delete_property( @keys )"
Delete the given properties. Behaves like the builtin \f(CW\*(C`delete()\*(C'\fR.
.ie n .IP "set_text_block( $text )" 4
.el .IP "set_text_block( \f(CW$text\fR )" 4
.IX Item "set_text_block( $text )"
.PD 0
.IP "\fBget_text_block()\fR" 4
.IX Item "get_text_block()"
.PD
Get or set the SVN::Dump::Text object that represents the record
text block.
.ie n .IP "set_included_record( $record )" 4
.el .IP "set_included_record( \f(CW$record\fR )" 4
.IX Item "set_included_record( $record )"
.PD 0
.IP "\fBget_included_record()\fR" 4
.IX Item "get_included_record()"
.PD
Some special record are actually output recursiveley by \fBsvnadmin dump\fR.
The \*(L"record in the record\*(R" is stored within the parent record, so they
are parsed as a single record with an included record.
.Sp
\&\f(CW\*(C`get_record()\*(C'\fR / \f(CW\*(C`set_record()\*(C'\fR give access to the included record.
.Sp
According to the Subversion sources (\fIsubversion/libsvn_repos/dump.c\fR),
this is a \*(L"delete original, then add-with-history\*(R" node. The dump looks
like this:
.Sp
.Vb 3
\&    Node\-path: tags/mytag/myfile
\&    Node\-kind: file
\&    Node\-action: delete
\&    
\&    Node\-path: tags/mytag/myfile
\&    Node\-kind: file
\&    Node\-action: add
\&    Node\-copyfrom\-rev: 23
\&    Node\-copyfrom\-path: trunk/myfile
.Ve
.Sp
Note that there is a single blank line after the first header block,
and four after the included one.
.IP "\fBupdate_headers()\fR" 4
.IX Item "update_headers()"
Update the various \f(CW\*(C`...\-length\*(C'\fR headers. Used internally.
.Sp
\&\fBYou must call this method if you update the inner property or text
blocks directly, or the results of \f(CB\*(C`as_string()\*(C'\fB will be inconsistent.\fR
.SS "Information methods"
.IX Subsection "Information methods"
.IP "\fBhas_prop()\fR" 4
.IX Item "has_prop()"
Return a boolean value indicating if the record has a property block.
.IP "\fBhas_text()\fR" 4
.IX Item "has_text()"
Return a boolean value indicating if the record has a text block.
.IP "\fBhas_prop_only()\fR" 4
.IX Item "has_prop_only()"
Return a boolean value indicating if the record has only a property block
(and no text block).
.IP "\fBhas_prop_or_text()\fR" 4
.IX Item "has_prop_or_text()"
Return a boolean value indicating if the record has a property block
or a text block.
.IP "\fBproperty_length()\fR" 4
.IX Item "property_length()"
Return the length of the property block.
.IP "\fBtext_length()\fR" 4
.IX Item "text_length()"
Return the length of the text block.
.SS "Output method"
.IX Subsection "Output method"
.IP "\fBas_string()\fR" 4
.IX Item "as_string()"
Return a string representation of the record that will be
understood by other Subversion tools, such as \f(CW\*(C`svnadmin\*(C'\fR.
.Sp
\&\fBWarning:\fR dumping a record currently returns the information that
was read from the original dump. This means that if you modified the
property or text block of a record, the headers will be inconsistent.
.SH "ENCAPSULATION"
.IX Header "ENCAPSULATION"
When using SVN::Dump to manipulate a \s-1SVN\s0 dump, one should not
access the SVN::Dump::Headers, SVN::Dump::Property and
SVN::Dump::Text components of a SVN::Dump::Record object directly, but use
the appropriate \f(CW\*(C`set_...()\*(C'\fR and \f(CW\*(C`get_...()\*(C'\fR methods of the record object.
.PP
These methods compute the appropriate modifications of the header values,
so that the \f(CW\*(C`as_string()\*(C'\fR method outputs the correct information after
any modification of the record.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
SVN::Dump, SVN::Dump::Reader,
SVN::Dump::Headers, SVN::Dump::Property, SVN::Dump::Text.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2006\-2013 Philippe Bruhat (BooK), All Rights Reserved.
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.