1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
|
=pod
=encoding utf-8
=head1 NAME
Type::Tiny::Manual::Policies - Type::Tiny policies
=head1 MANUAL
=head2 Type::Tiny Stability Policy
Type::Tiny 1.000000 is considered stable. Any changes to the API that
are big enough to I<require> changes to the test suite will be preceded
by a I<< six month >> notice period, with the following exceptions:
=over
=item *
Any changes which are necessary to maintain compatibility with new
releases of L<Moose>, L<Moo>, and other software that Type::Tiny needs
to integrate with.
=item *
Changes to maintain compatibility with future versions of Perl itself.
=item *
Where a change fixes a contradiction between the implementation and
documentation of Type::Tiny.
=item *
Where a feature is explicitly documented as being "experimental" or
"unstable".
=item *
Improvements to the text of error messages.
=back
=head2 Experimental and Unstable Type::Tiny Features
The following list is currently non-exhaustive.
=over
=item *
The following type checks result may vary based on your version of
Perl and whether Type::Tiny::XS is installed. Their outcome is currently
considered undefined, and may change in future versions.
=over
=item *
Using B<Object> and similar type checks on unblessed regular expression
references, the outcome is undefined.
=item *
On all current versions of Perl, false (C<< !!0 >>) stringifies to the
empty string (but using Devel::Peek you can tell the difference between
this value and a normal empty string), so B<Int> and subtypes of B<Int>
do not consider it to be an integer. If Perl's behaviour ever changes,
you might not be able to rely on this outcome. True (C<< !!1 >>)
stringifies as "1", so is considered an integer.
=item *
A glob (not a globref but an actual glob) currently passes the
B<StringLike> type constraint but not the B<Str> type constraint.
=back
=item *
L<Type::Tiny>'s C<my_methods> attribute and the functionality it
provides is experimental.
=item *
The L<parameterizable coercion API|Type::Coercion> is subject to change.
=item *
The interaction of deep coercions and mutable coercions currently results
in ill-defined behaviour. This could change at any time.
=item *
L<Type::Registry>'s ability to import L<MooseX::Types> and L<MouseX::Types>
type libraries is experimental.
=item *
These modules are considered part of Type::Tiny's internals, and not
covered by the stability policy:
L<Devel::TypeTiny::Perl58Compat>,
L<Type::Coercion::FromMoose>,
L<Type::Params::Alternatives>,
L<Type::Params::Parameter>,
L<Type::Params::Signature>,
L<Type::Tiny::_HalfOp>,
L<Types::Standard::ArrayRef>,
L<Types::Standard::CycleTuple>,
L<Types::Standard::Dict>,
L<Types::Standard::HashRef>,
L<Types::Standard::Map>,
L<Types::Standard::ScalarRef>,
L<Types::Standard::StrMatch>,
L<Types::Standard::Tied>, and
L<Types::Standard::Tuple>.
=item *
L<Reply::Plugin::TypeTiny> is not covered by the stability policy.
=back
=head2 Type::Tiny Versioning Policy
As of 1.000000, this distribution follows a versioning scheme similar
to L<Moo>, which is based on a L<semver|http://semver.org/>-like three
component version number, but with the last two components each
represented by three decimal digits in the fractional part of the
version number. That is, version 1.003002 of the software represents
"1.3.2".
Additionally, releases where the second component is an odd number will
be considered unstable/trial releases. (These will also include an
underscore in the version number as per the usual CPAN convention.)
=head2 Perl Version Support
Type::Tiny 0.000_01 to Type::Tiny 0.015_04 required Perl 5.8.1.
Type::Tiny 0.015_05+ and Type::Tiny 1.000000+ requires Perl 5.6.1.
Type::Tiny 2.000000+ will require Perl 5.8.1.
=head1 NEXT STEPS
Here's your next step:
=over
=item * L<Type::Tiny::Manual::Contributing>
Contributing to Type::Tiny development.
=back
=head1 AUTHOR
Toby Inkster E<lt>tobyink@cpan.orgE<gt>.
=head1 COPYRIGHT AND LICENCE
This software is copyright (c) 2013-2014, 2017-2023 by Toby Inkster.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=head1 DISCLAIMER OF WARRANTIES
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
=cut
|