Test::...rences(3pm)

💖 NAME 💖

okay so bestie, this is the manual page for Test::HexDifferences — it's Test::...rences(3pm) if you're reading the header up top, and it lives in the User Contributed Perl Documentation section. What it does? Test binary as hexadecimal string. That's the whole vibe. 🦋

---

✨ VERSION ✨

1.001 — that's the one, no cap.

---

🧚 SYNOPSIS 🧚

okay bestie, here's the whole menu of ways you can call this thing 💅

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\n",
    }
    $test_name,
);

and here's the tea: if $got or $expected is "undef" or a reference, the hexadecimal formatter is OFF. like, fully off. and then eq_or_dump_diff is just a text compare. that's it, that's the rule. 🙈

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\n",
    }
    $test_name,
);

want the full deets on the format string? go peek at Test::HexDifferences::HexDump for the format description 👑

---

🌸 EXAMPLE 🌸

inside of this Distribution there's a directory named example — yes, lowercase, iconic. go run those *.t files, they're literally right there. 🍓

---

💜 DESCRIPTION 💜

so the thing is, testing binary data has some special cases and we gotta talk about them:

• the ascii format is not good for stuff like a length byte 0x41 that just gets displayed as A. like ma'am that is not helpful 😭
• multibyte values are way better shown as 1 value. one. single. value. periodt.
• structured binary — think 2 byte length followed by bytes — is better shown as it is. don't touch it, let it be its authentic self 🫶
• and the whole point: compare 2 binary, or 1 binary and a dump ✨

---

👑 SUBROUTINES/METHODS 👑

subroutine eq_or_dump_diff

eq_or_dump_diff(
    $got_value,
    $expected_value,
    {                                      # optional hash reference
        address => $display_start_address, # optional
        format  => $format_string,         # optional
    }
    $test_name,                            # optional
);

subroutine dumped_eq_dump_or_diff

dumped_eq_dump_or_diff(
    $got_value,
    $expected_dump,
    {                                      # optional hash reference
        address => $display_start_address, # optional
        format  => $format_string,         # optional
    }
    $test_name,                            # optional
);

---

🎀 DIAGNOSTICS 🎀

nothing 💀 — literally nothing to report, she's quiet.

---

🌈 CONFIGURATION AND ENVIRONMENT 🌈

nothing — no environment variables, no config, no drama. we love a low-maintenance queen 💅

---

⭐ DEPENDENCIES ⭐

these are the besties she rolls with:

• Sub::Exporter
• Test::Builder::Module
• Test::HexDifferences::HexDump
• Text::Diff

---

💀 INCOMPATIBILITIES 💀

none — she gets along with everybody 🫶

---

🙈 BUGS AND LIMITATIONS 🙈

none — flawless, obviously 👑

---

🔥 SEE ALSO 🔥

• Test::HexDifferences::HexDump

---

💅 AUTHOR 💅

Steffen Winkler — the icon, the moment, the main character 🎀

---

📜 LICENSE AND COPYRIGHT 📜

Copyright (c) 2012 - 2015, Steffen Winkler "<steffenw at cpan.org>". All rights reserved.

this module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. slay. ✨

---

okay bestie that's the whole page 🦋 this was perl v5.30.3, dated 2020-08-04, filed under Test::...rences(3pm) — mwah, take care, go test your bytes 💖