Codes/Decodes entities from/to UTF-8

Introduced properties

abstract fun add_char_to(c: Char, s: CString): Int

core :: Codec :: add_char_to

Adds a char c to bytes s
abstract fun add_string_to(s: Text, b: Bytes): Int

core :: Codec :: add_string_to

Adds a string s coded as the supported encoding to b
abstract fun char_max_size: Int

core :: Codec :: char_max_size

Maximum size of a character in supported encoding
abstract fun codet_size: Int

core :: Codec :: codet_size

Size of a codet for the target encoding
abstract fun decode_char(b: CString): Char

core :: Codec :: decode_char

Decodes a char from b to a Unicode code-point
abstract fun decode_string(b: CString, len: Int): String

core :: Codec :: decode_string

Decodes a string b to UTF-8
abstract fun encode_char(c: Char): CString

core :: Codec :: encode_char

Transforms c to its representation in the format of self
abstract fun encode_string(s: Text): Bytes

core :: Codec :: encode_string

Transforms s to the format of self
abstract fun is_valid_char(ns: CString, position: Int): Int

core :: Codec :: is_valid_char

Is the sequence of bytes in ns at position a valid Char ?
abstract fun max_lookahead: Int

core :: Codec :: max_lookahead

How many lookaheads might be required to decode a single char ?

Redefined properties

redef type SELF: Codec

core $ Codec :: SELF

Type of this instance, automatically specialized in every class

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
abstract fun add_char_to(c: Char, s: CString): Int

core :: Codec :: add_char_to

Adds a char c to bytes s
abstract fun add_string_to(s: Text, b: Bytes): Int

core :: Codec :: add_string_to

Adds a string s coded as the supported encoding to b
abstract fun char_max_size: Int

core :: Codec :: char_max_size

Maximum size of a character in supported encoding
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
abstract fun codet_size: Int

core :: Codec :: codet_size

Size of a codet for the target encoding
abstract fun decode_char(b: CString): Char

core :: Codec :: decode_char

Decodes a char from b to a Unicode code-point
abstract fun decode_string(b: CString, len: Int): String

core :: Codec :: decode_string

Decodes a string b to UTF-8
abstract fun encode_char(c: Char): CString

core :: Codec :: encode_char

Transforms c to its representation in the format of self
abstract fun encode_string(s: Text): Bytes

core :: Codec :: encode_string

Transforms s to the format of self
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
abstract fun is_valid_char(ns: CString, position: Int): Int

core :: Codec :: is_valid_char

Is the sequence of bytes in ns at position a valid Char ?
abstract fun max_lookahead: Int

core :: Codec :: max_lookahead

How many lookaheads might be required to decode a single char ?
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
package_diagram core::Codec Codec core::Object Object core::Codec->core::Object

Parents

interface Object

core :: Object

The root of the class hierarchy.

Class definitions

core $ Codec
# Codes/Decodes entities from/to UTF-8
abstract class Codec
	# Maximum size of a `character` in supported encoding
	fun char_max_size: Int is abstract

	# Transforms `c` to its representation in the format of `self`
	fun encode_char(c: Char): CString is abstract

	# Adds a char `c` to bytes `s`
	#
	# Returns the number of bytes written to `s`
	fun add_char_to(c: Char, s: CString): Int is abstract

	# Transforms `s` to the format of `self`
	fun encode_string(s: Text): Bytes is abstract

	# Adds a string `s` coded as the supported encoding to `b`
	#
	# Returns the number of bytes written to `s`
	fun add_string_to(s: Text, b: Bytes): Int is abstract

	# Size of a codet for the target encoding
	fun codet_size: Int is abstract

	# How many lookaheads might be required to decode a single char ?
	fun max_lookahead: Int is abstract

	# Is the sequence of bytes in `ns` at `position` a valid Char ?
	#
	# Returns either
	# * 0 if valid
	# * 1 if incomplete
	# * 2 if invalid
	fun is_valid_char(ns: CString, position: Int): Int is abstract

	# Decodes a char from `b` to a Unicode code-point
	fun decode_char(b: CString): Char is abstract

	# Decodes a string `b` to UTF-8
	fun decode_string(b: CString, len: Int): String is abstract
end
lib/core/codecs/codec_base.nit:27,1--67,3