.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 "Alt::Assert 3pm"
.TH Alt::Assert 3pm "2022-11-27" "perl v5.36.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"
Alt::Assert \- Assert alternate module implementation
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Assuming there is a \s-1CPAN\s0 module Foo::Bar and mst wants to write an ALTernate
called Alt::Foo::Bar::MSTROUT.
.PP
In mst's Foo::Bar, there is the following line:
.PP
.Vb 1
\&    use constant ALT => \*(AqMSTROUT\*(Aq;
.Ve
.PP
In the alt module:
.PP
.Vb 3
\&    package Alt::Foo::Bar::MSTROUT;
\&    use Alt::Assert; # imports assert()
\&    1;
.Ve
.PP
Users use mst's Foo::Bar as normal, just like they would use the
original Foo::Bar:
.PP
.Vb 1
\&    use Foo::Bar \-various => [qw(weird import)], {API=>\*(Aqthings\*(Aq};
.Ve
.PP
or:
.PP
.Vb 1
\&    require Foo::Bar;
.Ve
.PP
If they want to assert they have the mst version, they can:
.PP
.Vb 2
\&    use Foo::Bar \-various => [qw(weird import)], {API=>\*(Aqthings\*(Aq};
\&    use Alt::Foo::Bar::MSTROUT;
.Ve
.PP
or:
.PP
.Vb 3
\&    require Foo::Bar;
\&    require Alt::Foo::Bar::MSTROUT;
\&    Alt::Foo::Bar::MSTROUT\->assert;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Alt::Assert can be used to assert that the loaded module is the wanted
alternate implementation. Using the Synopsis' example, there can be different
Foo::Bar installed, either from the original distribution, or from one of the
alternate ones. Each alternate might be slightly incompatible with the
original. The existence of Alt::Foo::Bar::MSTROUT in the installation does not
necessarily ensure that the installed Foo::Bar is from the same alternate
distribution, since an installer can replace Foo::Bar from another
distribution. That is why one might need to do this assertion.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Alt
.SH "AUTHOR"
.IX Header "AUTHOR"
Ingy döt Net <ingy@cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2012\-2014. Ingy döt Net.
.PP
See <http://www.perl.com/perl/misc/Artistic.html>