File: README

package info (click to toggle)
libtypes-uuid-perl 0.004-1.1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 156 kB
  • sloc: perl: 57; makefile: 12
file content (66 lines) | stat: -rw-r--r-- 1,932 bytes parent folder | download | duplicates (2)
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
NAME
    Types::UUID - type constraints for UUIDs

SYNOPSIS
       package FroobleStick;
   
       use Moo;
       use Types::UUID;
   
       has identifier => (
          is      => 'lazy',
          isa     => Uuid,
          coerce  => 1,
          builder => Uuid->generator,
       );

DESCRIPTION
    Types::UUID is a type constraint library suitable for use with Moo/Moose
    attributes, Kavorka sub signatures, and so forth.

  Type
    Currently the module only provides one type constraint, which is exported
    by default.

    `Uuid`
        A valid UUID string, as judged by the `is_uuid_string()` function
        provided by UUID::Tiny.

        This constraint has coercions from `Undef` (generates a new UUID),
        `Str` (fixes slightly broken-looking UUIDs, adding missing dashes;
        also accepts base-64-encoded UUIDs) and URI objects using the
        `urn:uuid:` URI scheme.

  Methods
    The `Uuid` type constraint is actually blessed into a subclass of
    Type::Tiny, and provides an aditional method:

    `Uuid->generate`
        Generates a new UUID. `Uuid->coerce(undef)` would also work, but looks
        a little odd.

    `Uuid->generator`
        Returns a coderef which generates a new UUID. For an example usage,
        see the "SYNOPSIS".

BUGS
    Please report any bugs to
    <http://rt.cpan.org/Dist/Display.html?Queue=Types-UUID>.

SEE ALSO
    Type::Tiny::Manual, UUID::Tiny.

AUTHOR
    Toby Inkster <tobyink@cpan.org>.

COPYRIGHT AND LICENCE
    This software is copyright (c) 2014 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.

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.