convert the XS implementation to its own dist
[gitmo/Package-Stash-XS.git] / lib / Package / Stash / XS.pm
1 package Package::Stash::XS;
2 use strict;
3 use warnings;
4 # ABSTRACT: faster and more correct implementation of the Package::Stash API
5
6 use XSLoader;
7 XSLoader::load(
8     __PACKAGE__,
9     # we need to be careful not to touch $VERSION at compile time, otherwise
10     # DynaLoader will assume it's set and check against it, which will cause
11     # fail when being run in the checkout without dzil having set the actual
12     # $VERSION
13     exists $Package::Stash::XS::{VERSION}
14         ? ${ $Package::Stash::XS::{VERSION} } : (),
15 );
16
17 =head1 SYNOPSIS
18
19   use Package::Stash;
20
21 =head1 DESCRIPTION
22
23 This is a backend for L<Package::Stash>, which provides the functionality in a
24 way that's less buggy and much faster. It will be used by default if it's
25 installed, and should be preferred in all environments with a compiler.
26
27 =head1 BUGS / CAVEATS
28
29 =over 4
30
31 =item * On perl versions prior to 5.10, undefined package scalars will not show up as existing, due to shortcomings within perl.
32
33 =item * GLOB and FORMAT variables are not (yet) accessible through this module.
34
35 =back
36
37 Please report any bugs through RT: email
38 C<bug-package-stash-xs at rt.cpan.org>, or browse to
39 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Package-Stash-XS>.
40
41 =head1 SEE ALSO
42
43 =over 4
44
45 =item * L<Class::MOP::Package>
46
47 This module is a factoring out of code that used to live here
48
49 =back
50
51 =head1 SUPPORT
52
53 You can find this documentation for this module with the perldoc command.
54
55     perldoc Package::Stash::XS
56
57 You can also look for information at:
58
59 =over 4
60
61 =item * AnnoCPAN: Annotated CPAN documentation
62
63 L<http://annocpan.org/dist/Package-Stash-XS>
64
65 =item * CPAN Ratings
66
67 L<http://cpanratings.perl.org/d/Package-Stash-XS>
68
69 =item * RT: CPAN's request tracker
70
71 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Package-Stash-XS>
72
73 =item * Search CPAN
74
75 L<http://search.cpan.org/dist/Package-Stash-XS>
76
77 =back
78
79 =head1 AUTHOR
80
81 Jesse Luehrs <doy at tozt dot net>
82
83 Based on code from L<Class::MOP::Package>, by Stevan Little and the Moose
84 Cabal.
85
86 =cut
87
88 1;