io.encodings vocabulary
Factor handbook » Vocabulary index

Documentation
I/O encodings

Metadata

Parents:	io
Tags:	text
Authors:	Daniel Ehrenberg, Slava Pestov

Words

Tuple classes

Class	Superclass	Slots
decode-error	tuple
decoder	tuple	stream code cr
encode-error	tuple
encoder	tuple	stream code

Generic words

Word	Stack effect
<decoder>	( stream encoding -- newstream )
<encoder>	( stream encoding -- newstream )
decode-char	( stream encoding -- char/f )
decode-until	( seps stream encoding -- string/f sep/f )
encode-char	( char stream encoding -- )
encode-string	( string stream encoding -- )
guess-decoded-length	( byte-length encoding -- string-length )
guess-encoded-length	( string-length encoding -- byte-length )
re-decode	( stream encoding -- newstream )
re-encode	( stream encoding -- newstream )

Ordinary words

Word	Stack effect
(decode-until)	( seps stream encoding -- string/f sep/f )
decode-error	( -- * )
decode-input	( encoding -- )
encode-error	( -- * )
encode-output	( encoding -- )
replacement-char	( -- value )
with-decoded-input	( encoding quot -- )
with-encoded-output	( encoding quot -- )

Class predicate words

Word	Stack effect
decode-error?	( object -- ? )
decoder?	( object -- ? )
encode-error?	( object -- ? )
encoder?	( object -- ? )

Files

resource:core/io/encodings/encodings.factor
resource:core/io/encodings/encodings-docs.factor
resource:core/io/encodings/encodings-tests.factor

Metadata files

resource:core/io/encodings/authors.txt
resource:core/io/encodings/summary.txt
resource:core/io/encodings/tags.txt

Children from resource:core

Vocabulary	Summary
io.encodings.ascii	ASCII encoding for streams
io.encodings.binary	Dummy encoding for binary I/O
io.encodings.utf16	UTF16 encoding/decoding
io.encodings.utf8	UTF8 encoding/decoding

Children from resource:basis

Vocabulary	Summary
io.encodings.8-bit	Definitions of 8-bit encodings like ISO 8859 and Windows 1252
io.encodings.big5
io.encodings.euc
io.encodings.euc-jp	EUC-JP text encoding
io.encodings.euc-kr	Korean text encodings
io.encodings.gb18030	GB18030 encoding for Chinese text
io.encodings.iana	Tables for IANA encoding names
io.encodings.iso2022	ISO-2022-JP-1 text encoding
io.encodings.johab	Johab Korean text encoding
io.encodings.latin1
io.encodings.shift-jis	Japanese text encodings
io.encodings.strict	Strict wrapper for encodings
io.encodings.string	Converting strings to byte arrays and vice versa
io.encodings.utf32	UTF32 encoding/decoding
io.encodings.utf7	UTF7 encoding/decoding

Children from resource:extra

Vocabulary	Summary
io.encodings.detect	Heuristic auto-detection of text encodings and binary files