Linux Manual Pages

Free Software * Books

Source Code

Free Media

Linux

Encode::Encoder

NAME
SYNOPSIS
ABSTRACT
Description
SEE ALSO

NAME

Encode::Encoder −− Object Oriented Encoder

SYNOPSIS

  use Encode::Encoder;
  # Encode::encode("ISO−8859−1", $data);
  Encode::Encoder−>new($data)−>iso_8859_1; # OOP way
  # shortcut
  use Encode::Encoder qw(encoder);
  encoder($data)−>iso_8859_1;
  # you can stack them!
  encoder($data)−>iso_8859_1−>base64;  # provided base64() is defined
  # you can use it as a decoder as well
  encoder($base64)−>bytes('base64')−>latin1;
  # stringified
  print encoder($data)−>utf8−>latin1;  # prints the string in latin1
  # numified
  encoder("\x{abcd}\x{ef}g")−>utf8 == 6; # true. bytes::length($data)

ABSTRACT

Encode::Encoder allows you to use Encode in an object-oriented style. This is not only more intuitive than a functional approach, but also handier when you want to stack encodings. Suppose you want your UTF−8 string converted to Latin1 then Base64: you can simply say

my $base64 = encoder($utf8)−>latin1−>base64;

instead of

my $latin1 = encode("latin1", $utf8);
my $base64 = encode_base64($utf8);

or the lazier and more convoluted

my $base64 = encode_base64(encode("latin1", $utf8));

Description

Here is how to use this module.

	•		There are at least two instance variables stored in a hash reference, {data} and {encoding}.
	•		When there is no method, it takes the method name as the name of the encoding and encodes the instance data with encoding. If successful, the instance encoding is set accordingly.
	•		You can retrieve the result via −>data but usually you don’t have to because the stringify operator ("") is overridden to do exactly that.

Predefined Methods
This module predefines the methods below:
$e = Encode::Encoder−>new([$data, $encoding]);

returns an encoder object. Its data is initialized with $data if present, and its encoding is set to $encoding if present.

When $encoding is omitted, it defaults to utf8 if $data is already in utf8 or "" (empty string) otherwise.

encoder()

is an alias of Encode::Encoder−>new(). This one is exported on demand.

$e−>data([$data])

When $data is present, sets the instance data to $data and returns the object itself. Otherwise, the current instance data is returned.

$e−>encoding([$encoding])

When $encoding is present, sets the instance encoding to $encoding and returns the object itself. Otherwise, the current instance encoding is returned.

$e−>bytes([$encoding])

decodes instance data from $encoding, or the instance encoding if omitted. If the conversion is successful, the instance encoding will be set to "".

The name bytes was deliberately picked to avoid namespace tainting -- this module may be used as a base class so method names that appear in Encode::Encoding are avoided.

Example: base64 transcoder
This module is designed to work with Encode::Encoding. To make the Base64 transcoder example above really work, you could write a module like this:

  package Encode::Base64;
  use base 'Encode::Encoding';
  __PACKAGE__−>Define('base64');
  use MIME::Base64;
  sub encode{
      my ($obj, $data) = @_;
      return encode_base64($data);
  }
  sub decode{
      my ($obj, $data) = @_;
      return decode_base64($data);
  }
  1;
  __END__

And your caller module would be something like this:

  use Encode::Encoder;
  use Encode::Base64;
  # now you can really do the following
  encoder($data)−>iso_8859_1−>base64;
  encoder($base64)−>bytes('base64')−>latin1;

Operator Overloading
This module overloads two operators, stringify ("") and numify (0+).

Stringify dumps the data inside the object.

Numify returns the number of bytes in the instance data.

They come in handy when you want to print or find the size of data.

Opportunity

Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.

Education

Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.