TITLE

SUBTITLE

The C<Encoding> role is implemented by classes that provide a character
encoding, such as ASCII or UTF-8. Besides being used by the built-in character
encodings, it may also be implemented by users to provide new encodings.
Instances of objects doing this role are typically obtained using
L<C<Encoding::Registry>|/type/Encoding::Registry>. For a list of supported encodings, see
L<IO::Handle|/type/IO::Handle#method_encoding>.


All methods provided by this role are stubs; they should be implemented by
consumers of the role.


head

Abstract method that would return the primary name of the encoding.


Abstract methods that should get a list of alternative names for the encoding.


method decoder(*%options --> Encoding::Decoder)


Should get a character decoder instance for this encoding, configured with the
provided options. Options vary by encoding. The built-in encodings all
support C<translate-nl>, which if C<True> will translate C<\r\n> into
C<\n> while decoding.


method encoder(*%options --> Encoding::Encoder)


Gets a character encoder instance for this encoding, configured with the
provided options. Options vary by encoding. The built-in encodings all support
both C<replacement> (either a L<C<Str>|/type/Str> replacement sequence or C<True> to use a
default replacement sequence for unencodable characters) and C<translate-nl>
(when set to C<True>, turns C<\n> into C<\r\n> if the current platform is
Windows).


root

Invocable code object


role Callable


Object that can be treated as a date


role Dateish


Distribution


role Distribution


Iterators that can predict number of values


role PredictiveIterator


Provide leading/trailing doc functionality


class RakuAST::Doc::DeclaratorTarget


Number stored as numerator and denominator


role Rational


Non-complex number


role Real


String or object that can act as a string


role Stringy


Support for character encodings.


para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


HEADER

FOOTER

role Encoding


C<Encoding::Registry> is initialized with a list of encoding that is
available for any Raku application, namely:


item

Register a new L<C<Encoding>|/type/Encoding>.


X<|Types,Encoding::Encoder>
X<|Types,Encoding::Decoder>


Finds an encoding by its name. Returns an C<Encoding::Encoder> or
C<Encoding::Decoder>, depending on what had been registered.


Native integer


class int


Dual value number and string


class Allomorph


Thing/object


class Any


Abstract representation of a piece of source code


class AST


Integer (native storage at the platform's atomic operation size)


class atomicint


Code object with its own lexical scope


class Block


Captures the current frame state


class CallFrame


Code object


class Code


Encapsulates instructions about how strings should be sorted


class Collation


Information related to the compiler that is being used


class Compiler


Complex number


class Complex


Dual value complex number and string


class ComplexStr


Object that can be treated as both a string and number


class Cool


Scheduler that synchronously executes code on the current thread


class CurrentThreadScheduler


Calendar date


class Date


Calendar date with time


class DateTime


Distribution::Hash


class Distribution::Hash


Distribution::Locally


class Distribution::Locally


Distribution::Path


class Distribution::Path


Every one of the resources installed with a distribution


class Distribution::Resource


Length of time


class Duration


Rational number (arbitrary-precision)


class FatRat


Rakudo-specific class that wraps around code in other languages (generally NQP)


class ForeignCode


Convert values to a string given a format specification


class Format


Produce Callable for given format specification


class Formatter


An object for performing batches of work in parallel with ordered
output


class HyperSeq


Placeholder for multiple unspecified values/arguments


class HyperWhatever


Specific moment in time


class Instant


Integer (arbitrary-precision)


class Int


Dual value integer and string


class IntStr


Logical superposition of values


class Junction


Tagged location in the source code


class Label


A non-blocking, non-re-entrant, mutual exclusion lock


class Lock::Async


Compile-time routine


class Macro


Member function


class Method


The root of the Raku type hierarchy.


class Mu


Absence of a value or a benign failure


class Nil


Floating-point number


class Num


Number or object that can act as a number


role Numeric


Dual value floating-point number and string


class NumStr


Unique identification for an object


class ObjAt


Element of a Signature


class Parameter


Perl related information


class Perl


Item container with custom storage and retrieval


class Proxy


Performs batches of work in parallel without respecting original
order.


class RaceSeq


Raku related information


class Raku


Namespace for holding RakuAST related classes


package RakuAST


Contains the information of a RakuDoc block


class RakuAST::Doc::Block


Contains the declarator docs of a RakuAST object


class RakuAST::Doc::Declarator


Contains the information about RakuDoc markup


class RakuAST::Doc::Markup


Contains the information about a RakuDoc paragraph


class RakuAST::Doc::Paragraph


Rational number (limited-precision)


class Rat


Dual value rational number and string


class RatStr


Code object with its own lexical scope and return handling


class Routine


Holds all information needed to unwrap a wrapped routine.


class Routine::WrapHandle


A mostly transparent container used for indirections


class Scalar


Parameter list pattern


class Signature


String of characters


class Str


Contains the result of a string transformation.


class StrDistance


Subroutine


class Sub


Member function that is not inherited by subclasses


class Submethod


Collect performance state for analysis


class Telemetry


Instrument for collecting Thread data


class Telemetry::Instrument::Thread


Instrument for collecting ThreadPoolScheduler data


class Telemetry::Instrument::ThreadPool


Instrument for collecting getrusage data


class Telemetry::Instrument::Usage


Performance data over a period


class Telemetry::Period


Telemetry instrument pod


class Telemetry::Sampler


Unsigned integer (arbitrary-precision)


Subset UInt


Unique identification for value types


class ValueObjAt


Object representation of a variable for use in traits


class Variable


Module version descriptor


class Version


Placeholder for the value of an unspecified argument


class Whatever


Code object constructed by Whatever-priming


class WhateverCode


Management of available encodings


class Encoding::Registry


A C<Duration> represents a length of time in atomic seconds, with
fractions. Like an L<C<Instant>|/type/Instant>, it is epoch-agnostic.


C<Duration>s can be subtracted from or added to L<C<Instant>|/type/Instant>s to yield another,
new L<C<Instant>|/type/Instant>. Subtracting one L<C<Instant>|/type/Instant> from another yields a C<Duration>. A
C<Duration> can also result from mathematical operations between two
C<Duration>s when it makes sense (namely, the addition, subtraction, or modulus
of two C<Duration>s). It can also be added, subtracted or divided modulo L<C<Real>|/type/Real>
numbers.


The type of object returned for other numeric operations is currently
unspecified.


The Raku Knowledge Base


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


role Encoding

Methods

method name

method alternative-names

method decoder

method encoder

See Also