.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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 "Test::HexDifferences 3pm"
.TH Test::HexDifferences 3pm "2020-08-04" "perl v5.30.3" "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"
Test::HexDifferences \- Test binary as hexadecimal string
.SH "VERSION"
.IX Header "VERSION"
1.001
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Test::HexDifferences;
\&
\&    eq_or_dump_diff(
\&        $got,
\&        $expected,
\&    );
\&
\&    eq_or_dump_diff(
\&        $got,
\&        $expected,
\&        $test_name,
\&    );
\&
\&    eq_or_dump_diff(
\&        $got,
\&        $expected,
\&        {
\&            address => $start_address,
\&            format  => "%a : %4C : %d\en",
\&        }
\&        $test_name,
\&    );
.Ve
.PP
If \f(CW$got\fR or \f(CW$expected\fR is \f(CW\*(C`undef\*(C'\fR or a reference,
the hexadecimal formatter is off.
Then \f(CW\*(C`eq_or_dump_diff\*(C'\fR is a text compare.
.PP
.Vb 4
\&    dumped_eq_dump_or_diff(
\&        $got_value,
\&        $expected_dump,
\&    );
\&
\&    dumped_eq_dump_or_diff(
\&        $got_value,
\&        $expected_dump,
\&        $test_name,
\&    );
\&
\&    dumped_eq_dump_or_diff(
\&        $got_value,
\&        $expected_dump,
\&        {
\&            address => $start_address,
\&            format  => "%a : %4C : %d\en",
\&        }
\&        $test_name,
\&    );
.Ve
.PP
See Test::HexDifferences::HexDump
for the format description.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
Inside of this Distribution is a directory named example.
Run this *.t files.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The are some special cases for testing binary data.
.IP "\(bu" 4
The ascii format is not good for e.g. a length byte 0x41 displayed as A.
.IP "\(bu" 4
Multibyte values are better shown as 1 value.
.IP "\(bu" 4
Structured binary e.g. 2 byte length followed by bytes better are shown as it is.
.IP "\(bu" 4
Compare 2 binary or 1 binary and a dump.
.SH "SUBROUTINES/METHODS"
.IX Header "SUBROUTINES/METHODS"
.SS "subroutine eq_or_dump_diff"
.IX Subsection "subroutine eq_or_dump_diff"
.Vb 9
\&    eq_or_dump_diff(
\&        $got_value,
\&        $expected_value,
\&        {                                      # optional hash reference
\&            address => $display_start_address, # optional
\&            format  => $format_string,         # optional
\&        }
\&        $test_name,                            # optional
\&    );
.Ve
.SS "subroutine dumped_eq_dump_or_diff"
.IX Subsection "subroutine dumped_eq_dump_or_diff"
.Vb 9
\&    dumped_eq_dump_or_diff(
\&        $got_value,
\&        $expected_dump,
\&        {                                      # optional hash reference
\&            address => $display_start_address, # optional
\&            format  => $format_string,         # optional
\&        }
\&        $test_name,                            # optional
\&    );
.Ve
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
nothing
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
nothing
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
Sub::Exporter
.PP
Test::Builder::Module
.PP
Test::HexDifferences::HexDump
.PP
Text::Diff
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
none
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
none
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Test::HexDifferences::HexDump
.SH "AUTHOR"
.IX Header "AUTHOR"
Steffen Winkler
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (c) 2012 \- 2015,
Steffen Winkler
\&\f(CW\*(C`<steffenw at cpan.org>\*(C'\fR.
All rights reserved.
.PP
This module is free software;
you can redistribute it and/or modify it
under the same terms as Perl itself.