NAME
    Unicode::UTF8 - Encoding and decoding of UTF-8 encoding form.

SYNOPSIS
        use Unicode::UTF8 qw[decode_utf8 encode_utf8];
    
        $string = decode_utf8($octets);
        $octets = encode_utf8($string);

DESCRIPTION
    This module provides functions to encode and decode UTF-8 encoding form
    as defined by Unicode and ISO/IEC 10646:2011.

    Here is a summary of features for comparison with Encode:

    *   simple API which integrates with warnings category "utf8"

    *   recognizes all noncharacters regardless of perl version

    *   implements Unicode's recommended practice for using U+FFFD

    *   helpful diagnostics in warnings messages

    *   detects and reports inconsistency in perl's internal encoding
        (UTF-X)

    *   preserves taintedness of decoded $octets or encoded $string

    *   much better performance ~ +600%
        <https://github.com/chansen/p5-unicode-utf8/blob/master/benchmarks/b
        ench.pl>

FUNCTIONS
  decode_utf8($octets)
    Returns an decoded representation of $octets in UTF-8 encoding as a
    character string.

    Issues a warning if $octets contains ill-formed UTF-8 sequences or
    encoded code points which can't be interchanged.

  encode_utf8($string)
    Returns an encoded representation of $string in UTF-8 encoding as an
    octet string.

    Issues a warning if $string contains code points which can't be
    interchanged or represented in UTF-8 encoding form.

EXPORTS
    None by default. All functions can be exported using the ":all" tag or
    individually.

DIAGNOSTICS
    Can't decode a wide character string
        (F) Wide character in octets.

    Can't decode ill-formed UTF-8 octet sequence <%s> in position %u
        (W utf8) Encountered an ill-formed UTF-8 octet sequence. <%s>
        contains a hexadecimal representation of the maximal subpart of the
        ill-formed subsequence.

    Can't interchange noncharacter code point U+%.4X at position %u
        (W utf8) Noncharacters is permanently reserved for internal use and
        that should never be interchanged. Noncharacters consist of the
        values U+nFFFE and U+nFFFF (where n is from 0 to 10^16) and the
        values U+FDD0..U+FDEF.

    Can't represent surrogate code point U+%.4X at position %u in UTF-8
    encoding form
        (W utf8) Surrogate code points are designated only for surrogate
        code units in the UTF-16 character encoding form. Surrogates consist
        of code points in the range U+D800 to U+DFFF.

    Can't represent super code point \x{%X} at position %u in UTF-8 encoding
    form
        (W utf8) Code points greater than U+10FFFF. Perl's extended
        codespace.

    Can't decode ill-formed UTF-X octet sequence <%s> in position %u
        (F) Encountered an ill-formed octet sequence in Perl's internal
        representation of wide characters.

SEE ALSO
    Encode

SUPPORT
  Bugs / Feature Requests
    Please report any bugs or feature requests by email to "bug-unicode-utf8
    at rt.cpan.org", or through the web interface at
    <http://rt.cpan.org/Public/Dist/Display.html?Name=Unicode-UTF8>. You
    will be automatically notified of any progress on the request by the
    system.

  Source Code
    This is open source software. The code repository is available for
    public review and contribution under the terms of the license.

    <http://github.com/chansen/p5-unicode-utf8>

        git clone http://github.com/chansen/p5-unicode-utf8

AUTHOR
    Christian Hansen "chansen@cpan.org"

COPYRIGHT
    Copyright 2011 by Christian Hansen.

    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.

