.\" 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::Reader 3pm"
.TH SVN::Dump::Reader 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::Reader \- A Subversion dump reader
.SH "VERSION"
.IX Header "VERSION"
version 0.08
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    # !!! You should use SVN::Dump, not SVN::Dump::Reader !!!
\&
\&    use SVN::Dump::Reader;
\&    my $reader = SVN::Dump::Reader\->new( $fh );
\&    my $record = $reader\->read_record();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The SVN::Dump::Reader class implements a reader object for Subversion
dumps.
.SH "METHODS"
.IX Header "METHODS"
The following methods are available:
.ie n .IP "new( $fh, \e%options )" 4
.el .IP "new( \f(CW$fh\fR, \e%options )" 4
.IX Item "new( $fh, %options )"
Create a new SVN::Dump::Reader attached to the \f(CW$fh\fR filehandle.
.Sp
The only supported option is \f(CW\*(C`check_digest\*(C'\fR, which is disabled
by default.
.IP "read_record( )" 4
.IX Item "read_record( )"
Read and return a new SVN::Dump::Record object from the dump filehandle.
.Sp
If the option \f(CW\*(C`check_digest\*(C'\fR is enabled, this method will recompute
the digests for a dump without deltas, based on the information in the
\&\f(CW\*(C`Text\-content\-md5\*(C'\fR and \f(CW\*(C`Text\-content\-sha1\*(C'\fR headers (if the corresponding
Digest module is available). In case of a mismatch, the routine
will \f(CW\*(C`die()\*(C'\fR with an exception complaining about a \f(CW\*(C`checksum mismatch\*(C'\fR.
.IP "read_header_block( )" 4
.IX Item "read_header_block( )"
Read and return a new SVN::Dump::Headers object from the dump filehandle.
.IP "read_property_block( )" 4
.IX Item "read_property_block( )"
Read and return a new SVN::Dump::Property object from the dump filehandle.
.IP "read_text_block( )" 4
.IX Item "read_text_block( )"
Read and return a new SVN::Dump::Text object from the dump filehandle.
.PP
The \f(CW\*(C`read_...\*(C'\fR methods will die horribly if asked to read inconsistent
data from a stream.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
SVN::Dump, SVN::Dump::Record, 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.