NAME

Encoding::FixLatin::XS - XS implementation layer for Encoding::FixLatin

SYNOPSIS

  use Encoding::FixLatin  qw(fix_latin);    # will load XS module if available
  my $utf8_string = fix_latin($mixed_encoding_string);

DESCRIPTION

This module provides a C implementation of the 'fix_latin' algorithm. It is not meant to be called directly. Instead, simply install this module and use Encoding::FixLatin as normal. Encoding::FixLatin will use this module if it's found and will fall back to the pure-Perl implementation otherwise.

The "fix_latin" function accepts a "use_xs" option which can be used to control how this module is used:

  # Default behaviour: try to load/use XS module, fall back to PP on failure
  $out = fix_latin($in, use_xs => 'auto');
  # Always try to load/use XS module, die if it's not available
  $out = fix_latin($in, use_xs => 'always');
  # Never try to load/use XS module, always use pure-Perl implementation
  $out = fix_latin($in, use_xs => 'never');

SEE ALSO

Encoding::FixLatin

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Encoding::FixLatin::XS

You can also look for information at:

• Issue tracker

  <https://github.com/grantm/encoding-fixlatin-xs/issues>

• AnnoCPAN: Annotated CPAN documentation

  <http://annocpan.org/dist/Encoding::FixLatin::XS>

• CPAN Ratings

  <http://cpanratings.perl.org/d/Encoding::FixLatin::XS>

• Search CPAN

  <http://search.cpan.org/dist/Encoding::FixLatin::XS/>

• Source Code Respository

  <http://github.com/grantm/encoding-fixlatin-xs>

COPYRIGHT AND LICENSE

Copyright (C) 2014 by Grant McLean "<grantm@cpan.org>"

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