The flexi-streams Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The flexi-streams Reference Manual

This is the flexi-streams Reference Manual, version 1.0.16, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:47:01 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction


FLEXI-STREAMS - Flexible bivalent streams for Common Lisp

FLEXI-STREAMS implements "virtual" bivalent streams that can be layered atop real binary or bivalent streams and that can be used to read and write character data in various single- or multi-octet encodings which can be changed on the fly. It also supplies in-memory binary streams which are similar to string streams.

Complete documentation for CL-INTERPOL can be found in the docs directory or at the project documentation site.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 flexi-streams

License

BSD-2-Clause

Description

Flexible bivalent streams for Common Lisp

Version

1.0.16

Dependency

trivial-gray-streams

Source

flexi-streams.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 flexi-streams.asd

Location

flexi-streams.asd

Systems

flexi-streams (system)

Packages

flexi-streams-system


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 flexi-streams/packages.lisp

Parent

flexi-streams (system)

Location

packages.lisp

Packages

flexi-streams


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 flexi-streams/mapping.lisp

Dependency

packages.lisp (file)

Parent

flexi-streams (system)

Location

mapping.lisp

Exported Definitions

octet (type)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 flexi-streams/ascii.lisp

Dependency

mapping.lisp (file)

Parent

flexi-streams (system)

Location

ascii.lisp

Internal Definitions

+ascii-table+ (constant)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 flexi-streams/koi8-r.lisp

Dependency

ascii.lisp (file)

Parent

flexi-streams (system)

Location

koi8-r.lisp

Internal Definitions

+koi8-r-table+ (constant)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 flexi-streams/iso-8859.lisp

Dependency

koi8-r.lisp (file)

Parent

flexi-streams (system)

Location

iso-8859.lisp

Internal Definitions

+iso-8859-tables+ (constant)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.7 flexi-streams/code-pages.lisp

Dependency

iso-8859.lisp (file)

Parent

flexi-streams (system)

Location

code-pages.lisp

Internal Definitions

+code-page-tables+ (constant)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.8 flexi-streams/specials.lisp

Dependency

code-pages.lisp (file)

Parent

flexi-streams (system)

Location

specials.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.9 flexi-streams/util.lisp

Dependency

specials.lisp (file)

Parent

flexi-streams (system)

Location

util.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.10 flexi-streams/conditions.lisp

Dependency

util.lisp (file)

Parent

flexi-streams (system)

Location

conditions.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.11 flexi-streams/external-format.lisp

Dependency

conditions.lisp (file)

Parent

flexi-streams (system)

Location

external-format.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.12 flexi-streams/length.lisp

Dependency

external-format.lisp (file)

Parent

flexi-streams (system)

Location

length.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.13 flexi-streams/encode.lisp

Dependency

length.lisp (file)

Parent

flexi-streams (system)

Location

encode.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.14 flexi-streams/decode.lisp

Dependency

encode.lisp (file)

Parent

flexi-streams (system)

Location

decode.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.15 flexi-streams/in-memory.lisp

Dependency

decode.lisp (file)

Parent

flexi-streams (system)

Location

in-memory.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.16 flexi-streams/stream.lisp

Dependency

in-memory.lisp (file)

Parent

flexi-streams (system)

Location

stream.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.17 flexi-streams/output.lisp

Dependency

stream.lisp (file)

Parent

flexi-streams (system)

Location

output.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.18 flexi-streams/input.lisp

Dependency

output.lisp (file)

Parent

flexi-streams (system)

Location

input.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.19 flexi-streams/io.lisp

Dependency

input.lisp (file)

Parent

flexi-streams (system)

Location

io.lisp

Exported Definitions

unread-byte (method)

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.20 flexi-streams/strings.lisp

Dependency

io.lisp (file)

Parent

flexi-streams (system)

Location

strings.lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 flexi-streams-system

Source

flexi-streams.asd

Use List

Previous: , Up: Packages   [Contents][Index]

4.2 flexi-streams

Source

packages.lisp (file)

Nickname

flex

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *default-eol-style*

The end-of-line style used by external formats if none is explicitly given. Depends on the OS the code is compiled on.

Package

flexi-streams

Source

specials.lisp (file)

Special Variable: *default-little-endian*

Whether external formats are little-endian by default (i.e. unless explicitly specified). Depends on the platform the code is compiled on.

Package

flexi-streams

Source

specials.lisp (file)

Special Variable: *substitution-char*

If this value is not NIL, it should be a character which is used (as if by a USE-VALUE restart) whenever during reading an error of type FLEXI-STREAM-ENCODING-ERROR would have been signalled otherwise.

Package

flexi-streams

Source

specials.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Macros

Macro: with-input-from-sequence (VAR SEQUENCE &key START END TRANSFORMER) &body BODY

Creates an IN-MEMORY input stream from SEQUENCE using the parameters START and END, binds VAR to this stream and then executes the code in BODY. A function TRANSFORMER may optionally be specified to transform the returned octets. The stream is automatically closed on exit from WITH-INPUT-FROM-SEQUENCE, no matter whether the exit is normal or abnormal. The return value of this macro is the return value of BODY.

Package

flexi-streams

Source

in-memory.lisp (file)

Macro: with-output-to-sequence (VAR &key AS-LIST ELEMENT-TYPE TRANSFORMER) &body BODY

Creates an IN-MEMORY output stream, binds VAR to this stream and then executes the code in BODY. The stream stores data of type ELEMENT-TYPE (a subtype of OCTET) which is (optionally) transformed by the function TRANSFORMER prior to storage. The stream is automatically closed on exit from WITH-OUTPUT-TO-SEQUENCE, no matter whether the exit is normal or abnormal. The return value of this macro is a vector (or a list if AS-LIST is true) containing the octets that were sent to the stream within BODY.

Package

flexi-streams

Source

in-memory.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Functions

Function: char-length SEQUENCE &key EXTERNAL-FORMAT START END

Kind of the inverse of OCTET-LENGTH. Returns the length of the subsequence (of octets) of SEQUENCE from START to END in characters if decoded using the external format EXTERNAL-FORMAT. Note that this function doesn’t check for the validity of the data in SEQUENCE.

This function is optimized for the case of SEQUENCE being a vector. Don’t use lists if you’re in a hurry.

Package

flexi-streams

Source

strings.lisp (file)

Function: external-format-equal EF1 EF2

Checks whether two EXTERNAL-FORMAT objects denote the same encoding.

Package

flexi-streams

Source

external-format.lisp (file)

Function: make-external-format NAME &rest ARGS &key LITTLE-ENDIAN ID EOL-STYLE

Creates and returns an external format object as specified. NAME is a keyword like :LATIN1 or :UTF-8, LITTLE-ENDIAN specifies the ‘endianess’ of the external format and is ignored for 8-bit encodings, EOL-STYLE is one of the keywords :CR, :LF, or :CRLF which denote the end-of-line character (sequence), ID is the ID of a Windows code page (and ignored for other encodings).

Package

flexi-streams

Source

external-format.lisp (file)

Function: make-flexi-stream STREAM &rest ARGS &key EXTERNAL-FORMAT ELEMENT-TYPE COLUMN POSITION BOUND

Creates and returns a new flexi stream. STREAM must be an open binary or ‘bivalent’ stream, i.e. it must be capable of reading/writing octets with READ-SEQUENCE and/or WRITE-SEQUENCE. The resulting flexi stream is an input stream if and only if STREAM is an input stream. Likewise, it’s an output stream if and only if STREAM is an output stream. The default for ELEMENT-TYPE is LW:SIMPLE-CHAR on LispWorks and CHARACTER on other Lisps. EXTERNAL-FORMAT must be an EXTERNAL-FORMAT object or a symbol or a list denoting such an object. COLUMN is the initial column of the stream which is either a non-negative integer or NIL. The COLUMN argument must only be used for output streams. POSITION (only used for input streams) should be an integer and it denotes the position the stream is in - it will be increased by one for each octet read. BOUND (only used for input streams) should be NIL or an integer. If BOUND is not NIL and POSITION has gone beyond BOUND, then the stream will behave as if no more input is available.

Package

flexi-streams

Source

stream.lisp (file)

Function: make-in-memory-output-stream &key ELEMENT-TYPE TRANSFORMER

Returns a binary output stream which accepts objects of type ELEMENT-TYPE (a subtype of OCTET) and makes available a sequence that contains the octes that were actually output. The octets stored will each be transformed by the optional TRANSFORMER function.

Package

flexi-streams

Source

in-memory.lisp (file)

Function: octet-length STRING &key EXTERNAL-FORMAT START END

Returns the length of the substring of STRING from START to END in octets if encoded using the external format EXTERNAL-FORMAT.

In spite of the name, STRING can be any sequence of characters, but the function is optimized for strings.

Package

flexi-streams

Source

strings.lisp (file)

Function: octets-to-string SEQUENCE &key EXTERNAL-FORMAT START END

Converts the Lisp sequence SEQUENCE of octets from START to END to a string using the external format designated by EXTERNAL-FORMAT.

This function is optimized for the case of SEQUENCE being a vector. Don’t use lists if you’re in a hurry.

Package

flexi-streams

Source

strings.lisp (file)

Function: string-to-octets STRING &key EXTERNAL-FORMAT START END

Converts the Lisp string STRING from START to END to an array of octets corresponding to the external format designated by EXTERNAL-FORMAT.

In spite of the name, STRING can be any sequence of characters, but the function is optimized for strings.

Package

flexi-streams

Source

strings.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Generic functions

Generic Function: external-format-condition-external-format CONDITION
Package

flexi-streams

Methods
Method: external-format-condition-external-format (CONDITION external-format-condition)
Source

conditions.lisp (file)

Generic Function: external-format-eol-style OBJECT
Package

flexi-streams

Methods
Method: external-format-eol-style (EXTERNAL-FORMAT external-format)

The character(s) to or from which
a #Newline will be translated - one of the keywords :CR, :LF, or :CRLF.

Source

external-format.lisp (file)

Generic Function: external-format-id OBJECT
Package

flexi-streams

Methods
Method: external-format-id (EXTERNAL-FORMAT external-format)

If the external format denotes a Windows
code page this ID specifies which one to use. Otherwise the value is ignored (and usually NIL).

Source

external-format.lisp (file)

Generic Function: external-format-little-endian OBJECT
Package

flexi-streams

Methods
Method: external-format-little-endian (EXTERNAL-FORMAT external-format)

Whether multi-octet values are
read and written with the least significant octet first. For 8-bit encodings like :ISO-8859-1 this value is ignored.

Source

external-format.lisp (file)

Generic Function: external-format-name OBJECT
Package

flexi-streams

Methods
Method: external-format-name (EXTERNAL-FORMAT external-format)

The name of the external format - a keyword.

Source

external-format.lisp (file)

Generic Function: flexi-stream-bound OBJECT
Generic Function: (setf flexi-stream-bound) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: flexi-stream-bound (FLEXI-INPUT-STREAM flexi-input-stream)
Method: (setf flexi-stream-bound) NEW-VALUE (FLEXI-INPUT-STREAM flexi-input-stream)

When this is not NIL, it must be an integer
and the stream will behave as if no more data is available as soon as POSITION is greater or equal than this value.

Source

stream.lisp (file)

Generic Function: flexi-stream-column OBJECT
Generic Function: (setf flexi-stream-column) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: flexi-stream-column (FLEXI-OUTPUT-STREAM flexi-output-stream)
Method: (setf flexi-stream-column) NEW-VALUE (FLEXI-OUTPUT-STREAM flexi-output-stream)

The current output column. A non-negative integer or NIL.

Source

stream.lisp (file)

Generic Function: flexi-stream-element-type OBJECT
Generic Function: (setf flexi-stream-element-type) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: flexi-stream-element-type (FLEXI-STREAM flexi-stream)
Method: (setf flexi-stream-element-type) NEW-VALUE (FLEXI-STREAM flexi-stream)

The element type of this stream.

Source

stream.lisp (file)

Method: (setf flexi-stream-element-type) NEW-VALUE (FLEXI-STREAM flexi-stream) before

Checks whether the new value makes sense before it is set.

Source

stream.lisp (file)

Generic Function: flexi-stream-element-type-error-element-type CONDITION
Package

flexi-streams

Methods
Method: flexi-stream-element-type-error-element-type (CONDITION flexi-stream-element-type-error)
Source

conditions.lisp (file)

Generic Function: flexi-stream-external-format OBJECT
Generic Function: (setf flexi-stream-external-format) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: flexi-stream-external-format (FLEXI-STREAM flexi-stream)
Method: (setf flexi-stream-external-format) NEW-VALUE (FLEXI-STREAM flexi-stream)

The encoding currently used
by this stream. Can be changed on the fly.

Source

stream.lisp (file)

Method: (setf flexi-stream-external-format) NEW-VALUE (FLEXI-STREAM flexi-stream) around

Converts the new value to an EXTERNAL-FORMAT object if necessary.

Source

stream.lisp (file)

Generic Function: flexi-stream-position OBJECT
Generic Function: (setf flexi-stream-position) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: flexi-stream-position (FLEXI-INPUT-STREAM flexi-input-stream)
Method: (setf flexi-stream-position) NEW-VALUE (FLEXI-INPUT-STREAM flexi-input-stream)

The position within the stream where each octet read counts as one.

Source

stream.lisp (file)

Generic Function: flexi-stream-stream OBJECT
Package

flexi-streams

Methods
Method: flexi-stream-stream (FLEXI-STREAM flexi-stream)

The actual stream that’s used for
input and/or output. It must be capable of reading/writing octets with READ-SEQUENCE and/or WRITE-SEQUENCE.

Source

stream.lisp (file)

Generic Function: get-output-stream-sequence STREAM &key AS-LIST
Package

flexi-streams

Methods
Method: get-output-stream-sequence (STREAM in-memory-output-stream) &key AS-LIST

Returns a vector containing, in order, all the octets that have been output to the IN-MEMORY stream STREAM. This operation clears any octets on STREAM, so the vector contains only those octets which have been output since the last call to GET-OUTPUT-STREAM-SEQUENCE or since the creation of the stream, whichever occurred most recently. If AS-LIST is true the return value is coerced to a list.

Source

in-memory.lisp (file)

Generic Function: in-memory-stream-position-spec-error-position-spec CONDITION
Package

flexi-streams

Methods
Method: in-memory-stream-position-spec-error-position-spec (CONDITION in-memory-stream-position-spec-error)
Source

conditions.lisp (file)

Generic Function: make-in-memory-input-stream VECTOR &key START END TRANSFORMER
Package

flexi-streams

Methods
Method: make-in-memory-input-stream (LIST list) &key START END TRANSFORMER

Returns a binary input stream which will supply, in order, the octets in the subsequence of LIST bounded by START and END. Each octet returned will be transformed in turn by the optional TRANSFORMER function.

Source

in-memory.lisp (file)

Method: make-in-memory-input-stream (VECTOR vector) &key START END TRANSFORMER

Returns a binary input stream which will supply, in order, the octets in the subsequence of VECTOR bounded by START and END. Each octet returned will be transformed in turn by the optional TRANSFORMER function.

Source

in-memory.lisp (file)

Generic Function: output-stream-sequence-length STREAM
Package

flexi-streams

Methods
Method: output-stream-sequence-length (STREAM in-memory-output-stream)

Returns the current length of the underlying vector of the IN-MEMORY output stream STREAM.

Source

in-memory.lisp (file)

Generic Function: peek-byte FLEXI-INPUT-STREAM &optional PEEK-TYPE EOF-ERROR-P EOF-VALUE
Package

flexi-streams

Methods
Method: peek-byte (FLEXI-INPUT-STREAM flexi-input-stream) &optional PEEK-TYPE EOF-ERROR-P EOF-VALUE

PEEK-BYTE is like PEEK-CHAR, i.e. it returns an octet from FLEXI-INPUT-STREAM without actually removing it. If PEEK-TYPE is NIL the next octet is returned, if PEEK-TYPE is T, the next octet which is not 0 is returned, if PEEK-TYPE is an octet, the next octet which equals PEEK-TYPE is returned. EOF-ERROR-P and EOF-VALUE are interpreted as usual.

Source

input.lisp (file)

Generic Function: unread-byte BYTE FLEXI-INPUT-STREAM
Package

flexi-streams

Methods
Method: unread-byte BYTE (STREAM flexi-io-stream) before
Source

io.lisp (file)

Method: unread-byte BYTE (FLEXI-INPUT-STREAM flexi-input-stream)

Similar to UNREAD-CHAR in that it ‘unreads’ the last octet from STREAM. Note that you can only call UNREAD-BYTE after a corresponding READ-BYTE.

Source

input.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Conditions

Condition: external-format-condition ()

Superclass for all conditions related to external formats.

Package

flexi-streams

Source

conditions.lisp (file)

Direct superclasses

simple-condition (condition)

Direct subclasses

external-format-error (condition)

Direct methods

external-format-condition-external-format (method)

Direct slots
Slot: external-format
Initargs

:external-format

Initform

(quote nil)

Readers

external-format-condition-external-format (generic function)

Condition: external-format-encoding-error ()

Errors of this type are signalled if there is an encoding problem.

Package

flexi-streams

Source

conditions.lisp (file)

Direct superclasses

external-format-error (condition)

Condition: external-format-error ()

Superclass for all errors related to external formats.

Package

flexi-streams

Source

conditions.lisp (file)

Direct superclasses
Direct subclasses

external-format-encoding-error (condition)

Condition: flexi-stream-element-type-error ()

Errors of this type are signalled if the flexi stream has a wrong element type.

Package

flexi-streams

Source

conditions.lisp (file)

Direct superclasses

flexi-stream-error (condition)

Direct methods

flexi-stream-element-type-error-element-type (method)

Direct slots
Slot: element-type
Initargs

:element-type

Readers

flexi-stream-element-type-error-element-type (generic function)

Condition: flexi-stream-error ()

Superclass for all errors related to flexi streams.

Package

flexi-streams

Source

conditions.lisp (file)

Direct superclasses

stream-error (condition)

Direct subclasses
Condition: flexi-stream-out-of-sync-error ()

This can happen if you’re trying to write to an IO
stream which had prior to that ‘looked ahead’ while reading and now can’t ‘rewind’ to the octet where you /should/ be.

Package

flexi-streams

Source

conditions.lisp (file)

Direct superclasses

flexi-stream-error (condition)

Condition: in-memory-stream-closed-error ()

An error that is signalled when someone is trying to read from or write to a closed IN-MEMORY stream.

Package

flexi-streams

Source

conditions.lisp (file)

Direct superclasses

in-memory-stream-error (condition)

Condition: in-memory-stream-error ()

Superclass for all errors related to IN-MEMORY streams.

Package

flexi-streams

Source

conditions.lisp (file)

Direct superclasses

stream-error (condition)

Direct subclasses
Condition: in-memory-stream-position-spec-error ()

Errors of this type are signalled if an erroneous position spec is used in conjunction with FILE-POSITION.

Package

flexi-streams

Source

conditions.lisp (file)

Direct superclasses

in-memory-stream-simple-error (condition)

Direct methods

in-memory-stream-position-spec-error-position-spec (method)

Direct slots
Slot: position-spec
Initargs

:position-spec

Readers

in-memory-stream-position-spec-error-position-spec (generic function)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.6 Classes

Class: flexi-input-stream ()

A FLEXI-INPUT-STREAM is a FLEXI-STREAM that
can actually be instatiated and used for input. Don’t use MAKE-INSTANCE to create a new FLEXI-INPUT-STREAM but use MAKE-FLEXI-STREAM instead.

Package

flexi-streams

Source

stream.lisp (file)

Direct superclasses
  • fundamental-character-input-stream (class)
  • fundamental-binary-input-stream (class)
  • flexi-stream (class)
Direct subclasses

flexi-io-stream (class)

Direct methods
Direct slots
Slot: last-char-code

This slot either holds NIL or the
last character (code) read successfully. This is mainly used for UNREAD-CHAR sanity checks.

Readers

flexi-stream-last-char-code (generic function)

Writers

(setf flexi-stream-last-char-code) (generic function)

Slot: last-octet

This slot either holds NIL or the last
octet read successfully from the stream using a ‘binary’ operation such as READ-BYTE. This is mainly used for UNREAD-BYTE sanity checks.

Readers

flexi-stream-last-octet (generic function)

Writers

(setf flexi-stream-last-octet) (generic function)

Slot: octet-stack

A small buffer which holds octets
that were already read from the underlying stream but not yet used to produce characters. This is mainly used if we have to look ahead for a CR/LF line ending.

Readers

flexi-stream-octet-stack (generic function)

Writers

(setf flexi-stream-octet-stack) (generic function)

Slot: position

The position within the stream where each octet read counts as one.

Type

integer

Initargs

:position

Initform

0

Readers

flexi-stream-position (generic function)

Writers

(setf flexi-stream-position) (generic function)

Slot: bound

When this is not NIL, it must be an integer
and the stream will behave as if no more data is available as soon as POSITION is greater or equal than this value.

Type

(or null integer)

Initargs

:bound

Readers

flexi-stream-bound (generic function)

Writers

(setf flexi-stream-bound) (generic function)

Class: flexi-io-stream ()

A FLEXI-IO-STREAM is a FLEXI-STREAM that can
actually be instatiated and used for input and output. Don’t use MAKE-INSTANCE to create a new FLEXI-IO-STREAM but use MAKE-FLEXI-STREAM instead.

Package

flexi-streams

Source

stream.lisp (file)

Direct superclasses
Direct methods
  • write-byte* (method)
  • stream-clear-input (method)
  • unread-byte (method)
  • stream-unread-char (method)
  • stream-read-sequence (method)
  • stream-read-char (method)
  • stream-read-byte (method)
  • reset-output-state (method)
  • stream-clear-output (method)
  • stream-write-sequence (method)
  • stream-write-char (method)
  • stream-write-byte (method)
  • reset-input-state (method)
Class: flexi-output-stream ()

A FLEXI-OUTPUT-STREAM is a FLEXI-STREAM that
can actually be instatiated and used for output. Don’t use MAKE-INSTANCE to create a new FLEXI-OUTPUT-STREAM but use MAKE-FLEXI-STREAM instead.

Package

flexi-streams

Source

stream.lisp (file)

Direct superclasses
  • fundamental-character-output-stream (class)
  • fundamental-binary-output-stream (class)
  • flexi-stream (class)
Direct subclasses

flexi-io-stream (class)

Direct methods
  • stream-write-string (method)
  • stream-write-sequence (method)
  • stream-write-byte (method)
  • stream-line-column (method)
  • stream-force-output (method)
  • stream-finish-output (method)
  • stream-clear-output (method)
  • stream-write-char (method)
  • stream-write-char (method)
  • write-byte* (method)
  • flexi-stream-column (method)
  • flexi-stream-column (method)
Direct slots
Slot: column

The current output column. A non-negative integer or NIL.

Initform

0

Readers

flexi-stream-column (generic function)

Writers

(setf flexi-stream-column) (generic function)

Class: flexi-stream ()

A FLEXI-STREAM object is a stream that’s
‘layered’ atop an existing binary/bivalent stream in order to allow for multi-octet external formats. FLEXI-STREAM itself is a mixin and should not be instantiated.

Package

flexi-streams

Source

stream.lisp (file)

Direct superclasses

trivial-gray-stream-mixin (class)

Direct subclasses
Direct methods
Direct slots
Slot: stream

The actual stream that’s used for
input and/or output. It must be capable of reading/writing octets with READ-SEQUENCE and/or WRITE-SEQUENCE.

Initargs

:stream

Readers

flexi-stream-stream (generic function)

Slot: external-format

The encoding currently used
by this stream. Can be changed on the fly.

Initargs

:flexi-stream-external-format

Initform

(flexi-streams:make-external-format :iso-8859-1)

Readers

flexi-stream-external-format (generic function)

Writers

(setf flexi-stream-external-format) (generic function)

Slot: element-type

The element type of this stream.

Initargs

:element-type

Initform

(quote flexi-streams::char*)

Readers

flexi-stream-element-type (generic function)

Writers

(setf flexi-stream-element-type) (generic function)

Class: in-memory-input-stream ()

An IN-MEMORY-INPUT-STREAM is a binary stream that reads octets from a sequence in RAM.

Package

flexi-streams

Source

in-memory.lisp (file)

Direct superclasses
Direct subclasses
Class: in-memory-output-stream ()

An IN-MEMORY-OUTPUT-STREAM is a binary stream that writes octets to a sequence in RAM.

Package

flexi-streams

Source

in-memory.lisp (file)

Direct superclasses
Direct subclasses

vector-output-stream (class)

Direct methods
Class: in-memory-stream ()

An IN-MEMORY-STREAM is a binary stream that reads octets from or writes octets to a sequence in RAM.

Package

flexi-streams

Source

in-memory.lisp (file)

Direct superclasses

trivial-gray-stream-mixin (class)

Direct subclasses
Direct methods
Direct slots
Slot: transformer

A function used to transform the
written/read octet to the value stored/retrieved in/from the underlying vector.

Initargs

:transformer

Readers

in-memory-stream-transformer (generic function)

Writers

(setf in-memory-stream-transformer) (generic function)

Class: list-stream ()

A LIST-STREAM is a mixin for IN-MEMORY streams where the underlying sequence is a list.

Package

flexi-streams

Source

in-memory.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

list-input-stream (class)

Direct methods
Direct slots
Slot: list

The underlying list of the stream.

Initargs

:list

Readers

list-stream-list (generic function)

Writers

(setf list-stream-list) (generic function)

Class: vector-stream ()

A VECTOR-STREAM is a mixin for IN-MEMORY streams where the underlying sequence is a vector.

Package

flexi-streams

Source

in-memory.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: vector

The underlying vector of the stream which
(for output) must always be adjustable and have a fill pointer.

Initargs

:vector

Readers

vector-stream-vector (generic function)

Writers

(setf vector-stream-vector) (generic function)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.7 Types

Type: octet ()

A shortcut for (UNSIGNED-BYTE 8).

Package

flexi-streams

Source

mapping.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Constants

Constant: +ascii-hash+

A hash table which maps US-ASCII character codes to the corresponding octets.

Package

flexi-streams

Source

specials.lisp (file)

Constant: +ascii-table+

An array enumerating the character codes for the US-ASCII encoding.

Package

flexi-streams

Source

ascii.lisp (file)

Constant: +buffer-size+

Default size for buffers used for internal purposes.

Package

flexi-streams

Source

specials.lisp (file)

Constant: +code-page-hashes+

An alist which maps IDs of Windows code pages to hash tables which map character codes to the corresponding octets.

Package

flexi-streams

Source

specials.lisp (file)

Constant: +code-page-tables+

A list of 8-bit Windows code pages where each element is a cons with the car being the ID of the code page and the cdr being a vector enumerating the corresponding character codes.

Package

flexi-streams

Source

code-pages.lisp (file)

Constant: +cr+
Package

flexi-streams

Source

specials.lisp (file)

Constant: +iso-8859-hashes+

An alist which maps names for ISO-8859 encodings to hash tables which map character codes to the corresponding octets.

Package

flexi-streams

Source

specials.lisp (file)

Constant: +iso-8859-tables+

A list of the ISO-8859 encodings where each element is a cons with the car being a keyword denoting the encoding and the cdr being a vector enumerating the corresponding character codes.

Package

flexi-streams

Source

iso-8859.lisp (file)

Constant: +koi8-r-hash+

A hash table which maps KOI8-R character codes to the corresponding octets.

Package

flexi-streams

Source

specials.lisp (file)

Constant: +koi8-r-table+

An array enumerating the character codes for the KOI8-R encoding.

Package

flexi-streams

Source

koi8-r.lisp (file)

Constant: +lf+
Package

flexi-streams

Source

specials.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Special variables

Special Variable: *current-unreader*

A unary function which might be called to ‘unread’ a character (i.e. the sequence of octets it represents).

Used by the function OCTETS-TO-CHAR-CODE and must always be bound to a suitable functional object when this function is called.

Package

flexi-streams

Source

specials.lisp (file)

Special Variable: *fixnum-optimize-settings*

Like *STANDARD-OPTIMIZE-SETTINGS*, but (on LispWorks) with all arithmetic being fixnum arithmetic.

Package

flexi-streams

Source

specials.lisp (file)

Special Variable: *hyperdoc-base-uri*
Package

flexi-streams

Source

specials.lisp (file)

Special Variable: *standard-optimize-settings*

The standard optimize settings used by most declaration expressions.

Package

flexi-streams

Source

specials.lisp (file)

Special Variable: +name-map+

An alist which mapes alternative names for external formats to their canonical counterparts.

Package

flexi-streams

Source

specials.lisp (file)

Special Variable: +shortcut-map+

An alist which maps shortcuts for external formats to their long forms.

Package

flexi-streams

Source

specials.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Macros

Macro: ash* INTEGER COUNT

Solely for optimization purposes. Some Lisps need it, some don’t.

Package

flexi-streams

Source

util.lisp (file)

Macro: defconstant NAME VALUE &optional DOC

Make sure VALUE is evaluated only once (to appease SBCL).

Package

flexi-streams

Source

mapping.lisp (file)

Macro: define-char-decoders (LF-FORMAT-CLASS CR-FORMAT-CLASS CRLF-FORMAT-CLASS) &body BODY

Non-hygienic utility macro which defines several decoding-related methods for the classes LF-FORMAT-CLASS, CR-FORMAT-CLASS, and CRLF-FORMAT-CLASS where it is assumed that CR-FORMAT-CLASS is the same encoding as LF-FORMAT-CLASS but with CR instead of LF line endings and similar for CRLF-FORMAT-CLASS, i.e. LF-FORMAT-CLASS is the base class. BODY is a code template for the code to read octets and return one character code. BODY must contain a symbol OCTET-GETTER representing the form which is used to obtain the next octet.

Package

flexi-streams

Source

decode.lisp (file)

Macro: define-char-encoders (LF-FORMAT-CLASS CR-FORMAT-CLASS CRLF-FORMAT-CLASS) &body BODY

Non-hygienic utility macro which defines several encoding-related methods for the classes LF-FORMAT-CLASS, CR-FORMAT-CLASS, and CRLF-FORMAT-CLASS where it is assumed that CR-FORMAT-CLASS is the same encoding as LF-FORMAT-CLASS but with CR instead of LF line endings and similar for CRLF-FORMAT-CLASS, i.e. LF-FORMAT-CLASS is the base class. BODY is a code template for the code to convert one character to octets. BODY must contain a symbol CHAR-GETTER representing the form which is used to obtain the character and a forms like (OCTET-WRITE <thing>) to write the octet <thing>. The CHAR-GETTER form might be called more than once.

Package

flexi-streams

Source

encode.lisp (file)

Macro: define-sequence-readers (FORMAT-CLASS) &body BODY

Non-hygienic utility macro which defines methods for READ-SEQUENCE* and OCTETS-TO-STRING* for the class FORMAT-CLASS. BODY is described in the docstring of DEFINE-CHAR-ENCODERS but can additionally contain a form (UNGET <form>) which has to be replaced by the correct code to ‘unread’ the octets for the character designated by <form>.

Package

flexi-streams

Source

decode.lisp (file)

Macro: define-sequence-writers (FORMAT-CLASS) &body BODY

Non-hygienic utility macro which defines methods for WRITE-SEQUENCE* and STRING-TO-OCTETS* for the class FORMAT-CLASS. For BODY see the docstring of DEFINE-CHAR-ENCODERS.

Package

flexi-streams

Source

encode.lisp (file)

Macro: logand* X Y

Solely for optimization purposes. Some Lisps need it, some don’t.

Package

flexi-streams

Source

util.lisp (file)

Macro: logior* X Y

Solely for optimization purposes. Some Lisps need it, some don’t.

Package

flexi-streams

Source

util.lisp (file)

Macro: when-let (VAR FORM) &body BODY

Evaluates FORM and binds VAR to the result, then executes BODY if VAR has a true value.

Package

flexi-streams

Source

util.lisp (file)

Macro: with-rebinding BINDINGS &body BODY

WITH-REBINDING ( { var | (var prefix) }* ) form*

Evaluates a series of forms in the lexical environment that is formed by adding the binding of each VAR to a fresh, uninterned symbol, and the binding of that fresh, uninterned symbol to VAR’s original value, i.e., its value in the current lexical environment.

The uninterned symbol is created as if by a call to GENSYM with the string denoted by PREFIX - or, if PREFIX is not supplied, the string denoted by VAR - as argument.

The forms are evaluated in order, and the values of all but the last are discarded (that is, the body is an implicit PROGN).

Package

flexi-streams

Source

util.lisp (file)

Macro: with-unique-names (&rest BINDINGS) &body BODY

Syntax: WITH-UNIQUE-NAMES ( { var | (var x) }* ) declaration* form*

Executes a series of forms with each VAR bound to a fresh, uninterned symbol. The uninterned symbol is as if returned by a call to GENSYM with the string denoted by X - or, if X is not supplied, the string denoted by VAR - as argument.

The variable bindings created are lexical unless special declarations are specified. The scopes of the name bindings and declarations do not include the Xs.

The forms are evaluated in order, and the values of all but the last are discarded (that is, the body is an implicit PROGN).

Package

flexi-streams

Source

util.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Functions

Function: ascii-name-p NAME

Checks whether NAME is the keyword :ASCII.

Package

flexi-streams

Source

util.lisp (file)

Function: code-page-name-p NAME

Checks whether NAME is the keyword :CODE-PAGE.

Package

flexi-streams

Source

util.lisp (file)

Function: external-format-class-name REAL-NAME &key EOL-STYLE LITTLE-ENDIAN ID

Given the initargs for a general external format returns the name (a symbol) of the most specific subclass matching these arguments.

Package

flexi-streams

Source

external-format.lisp (file)

Function: hyperdoc-lookup SYMBOL TYPE
Package

flexi-streams

Source

specials.lisp (file)

Function: invert-table TABLE

‘Inverts’ an array which maps octets to character codes to a hash table which maps character codes to octets.

Package

flexi-streams

Source

mapping.lisp (file)

Function: iso-8859-name-p NAME

Checks whether NAME (a keyword) names one of the known ISO-8859 encodings.

Package

flexi-streams

Source

util.lisp (file)

Function: known-code-page-id-p ID

Checks whether ID (a number) denotes one of the known Windows code pages.

Package

flexi-streams

Source

util.lisp (file)

Function: koi8-r-name-p NAME

Checks whether NAME is the keyword :KOI8-R.

Package

flexi-streams

Source

util.lisp (file)

Function: make-decoding-table LIST

Creates and returns an array which contains the elements in the list LIST and has an element type that’s suitable for character codes.

Package

flexi-streams

Source

mapping.lisp (file)

Function: make-external-format% NAME &key LITTLE-ENDIAN ID EOL-STYLE

Used internally by MAKE-EXTERNAL-FORMAT to default some of the keywords arguments and to determine the right subclass of EXTERNAL-FORMAT.

Package

flexi-streams

Source

external-format.lisp (file)

Function: make-octet-buffer &optional SIZE

Creates and returns a fresh buffer (a specialized array) of size +BUFFER-SIZE+ to hold octets.

Package

flexi-streams

Source

util.lisp (file)

Function: make-output-vector &key ELEMENT-TYPE

Creates and returns an array which can be used as the underlying vector for a VECTOR-OUTPUT-STREAM.

Package

flexi-streams

Source

in-memory.lisp (file)

Function: maybe-convert-external-format EXTERNAL-FORMAT

Given an external format designator (a keyword, a list, or an EXTERNAL-FORMAT object) returns the corresponding EXTERNAL-FORMAT object.

Package

flexi-streams

Source

external-format.lisp (file)

Function: maybe-rewind STREAM OCTETS

Tries to ‘rewind’ the (binary) stream STREAM by OCTETS octets. Returns T if it succeeds, otherwise NIL.

Package

flexi-streams

Source

util.lisp (file)

Function: normalize-external-format EXTERNAL-FORMAT

Returns a list which is a ‘normalized’ representation of the external format EXTERNAL-FORMAT. Used internally by PRINT-OBJECT, for example. Basically, the result is an argument list that can be fed back to MAKE-EXTERNAL-FORMAT to create an equivalent object.

Package

flexi-streams

Source

external-format.lisp (file)

Function: normalize-external-format-name NAME

Converts NAME (a symbol) to a ‘canonical’ name for an external format, e.g. :LATIN1 will be converted to :ISO-8859-1. Also checks if there is an external format with that name and signals an error otherwise.

Package

flexi-streams

Source

util.lisp (file)

Function: recover-from-encoding-error EXTERNAL-FORMAT FORMAT-CONTROL &rest FORMAT-ARGS

Helper function used by OCTETS-TO-CHAR-CODE below to deal with encoding errors. Checks if *SUBSTITUTION-CHAR* is not NIL and returns its character code in this case. Otherwise signals an EXTERNAL-FORMAT-ENCODING-ERROR as determined by the arguments to this function and provides a corresponding USE-VALUE restart.

Package

flexi-streams

Source

decode.lisp (file)

Function: sans PLIST &rest KEYS

Returns PLIST with keyword arguments from KEYS removed.

Package

flexi-streams

Source

util.lisp (file)

Function: signal-encoding-error EXTERNAL-FORMAT FORMAT-CONTROL &rest FORMAT-ARGS

Convenience function similar to ERROR to signal conditions of type EXTERNAL-FORMAT-ENCODING-ERROR.

Package

flexi-streams

Source

conditions.lisp (file)

Function: type-equal TYPE1 TYPE2

Whether TYPE1 and TYPE2 denote the same type.

Package

flexi-streams

Source

util.lisp (file)

Function: unread-char% CHAR FLEXI-INPUT-STREAM

Used internally to put a character CHAR which was already read back on the stream. Uses the OCTET-STACK slot and decrements the POSITION slot accordingly.

Package

flexi-streams

Source

input.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Generic functions

Generic Function: char-to-octets FORMAT CHAR WRITER

Converts the character CHAR to a sequence of octets
using the external format FORMAT. The conversion is performed by calling the unary function (which must be a functional object) WRITER repeatedly each octet. The return value of this function is unspecified.

Package

flexi-streams

Source

encode.lisp (file)

Methods
Method: char-to-octets (FORMAT flexi-crlf-mixin) CHAR WRITER
Method: char-to-octets (FORMAT flexi-cr-mixin) CHAR WRITER
Method: char-to-octets (FORMAT flexi-utf-32-be-format) CHAR WRITER
Method: char-to-octets (FORMAT flexi-utf-32-le-format) CHAR WRITER
Method: char-to-octets (FORMAT flexi-utf-16-be-format) CHAR WRITER
Method: char-to-octets (FORMAT flexi-utf-16-le-format) CHAR WRITER
Method: char-to-octets (FORMAT flexi-utf-8-format) CHAR WRITER
Method: char-to-octets (FORMAT flexi-8-bit-format) CHAR WRITER
Method: char-to-octets (FORMAT flexi-ascii-format) CHAR WRITER
Method: char-to-octets (FORMAT flexi-latin-1-format) CHAR WRITER
Generic Function: character-length FORMAT CHAR

Returns the number of octets needed to encode the single character CHAR.

Package

flexi-streams

Source

length.lisp (file)

Methods
Method: character-length (FORMAT flexi-utf-32-format) CHAR
Method: character-length (FORMAT flexi-8-bit-format) CHAR
Method: character-length (FORMAT flexi-crlf-mixin) (CHAR (eql ↩)) around
Method: character-length FORMAT CHAR
Generic Function: check-end FORMAT START END I

Helper function used below to determine if we tried to read past the end of the sequence.

Package

flexi-streams

Source

length.lisp (file)

Methods
Method: check-end FORMAT START END I
Method: check-end (FORMAT flexi-utf-16-format) START END I
Generic Function: check-if-open STREAM
Package

flexi-streams

Methods
Method: check-if-open (STREAM in-memory-stream)

Checks if STREAM is open and signals an error otherwise.

Source

in-memory.lisp (file)

Generic Function: compute-number-of-chars FORMAT SEQUENCE START END

Computes the exact number of characters required to
decode the sequence of octets in SEQUENCE from START to END using the external format FORMAT.

Package

flexi-streams

Source

length.lisp (file)

Methods
Method: compute-number-of-chars (FORMAT flexi-crlf-utf-32-be-format) SEQUENCE START END
Method: compute-number-of-chars (FORMAT flexi-crlf-utf-32-le-format) SEQUENCE START END
Method: compute-number-of-chars (FORMAT flexi-utf-32-format) SEQUENCE START END
Method: compute-number-of-chars (FORMAT flexi-utf-32-format) SEQUENCE START END before
Method: compute-number-of-chars (FORMAT flexi-crlf-utf-16-be-format) SEQUENCE START END
Method: compute-number-of-chars (FORMAT flexi-crlf-utf-16-le-format) SEQUENCE START END
Method: compute-number-of-chars (FORMAT flexi-utf-16-be-format) SEQUENCE START END
Method: compute-number-of-chars (FORMAT flexi-utf-16-le-format) SEQUENCE START END
Method: compute-number-of-chars (FORMAT flexi-utf-16-format) SEQUENCE START END before
Method: compute-number-of-chars (FORMAT flexi-crlf-utf-8-format) SEQUENCE START END
Method: compute-number-of-chars (FORMAT flexi-utf-8-format) SEQUENCE START END
Method: compute-number-of-chars (FORMAT flexi-crlf-mixin) SEQUENCE START END
Method: compute-number-of-chars (FORMAT flexi-8-bit-format) SEQUENCE START END
Method: compute-number-of-chars FORMAT (LIST list) START END around
Generic Function: compute-number-of-octets FORMAT SEQUENCE START END

Computes the exact number of octets required to
encode the sequence of characters in SEQUENCE from START to END using the external format FORMAT.

Package

flexi-streams

Source

length.lisp (file)

Methods
Method: compute-number-of-octets (FORMAT flexi-crlf-mixin) STRING START END
Method: compute-number-of-octets (FORMAT flexi-utf-32-format) STRING START END
Method: compute-number-of-octets (FORMAT flexi-crlf-utf-16-be-format) STRING START END
Method: compute-number-of-octets (FORMAT flexi-crlf-utf-16-le-format) STRING START END
Method: compute-number-of-octets (FORMAT flexi-utf-16-format) STRING START END
Method: compute-number-of-octets (FORMAT flexi-crlf-utf-8-format) STRING START END
Method: compute-number-of-octets (FORMAT flexi-utf-8-format) STRING START END
Method: compute-number-of-octets (FORMAT flexi-8-bit-format) STRING START END
Method: compute-number-of-octets FORMAT (LIST list) START END around
Generic Function: encoding-factor FORMAT

Given an external format FORMAT, returns a factor
which denotes the octets to characters ratio to expect when encoding/decoding. If the returned value is an integer, the factor is assumed to be exact. If it is a (double) float, the factor is supposed to be based on heuristics and usually not exact.

This factor is used in string.lisp.

Package

flexi-streams

Source

length.lisp (file)

Methods
Method: encoding-factor (FORMAT flexi-crlf-mixin)
Method: encoding-factor (FORMAT flexi-utf-32-format)
Method: encoding-factor (FORMAT flexi-utf-16-format)
Method: encoding-factor (FORMAT flexi-utf-8-format)
Method: encoding-factor (FORMAT flexi-8-bit-format)
Generic Function: external-format-decoding-table OBJECT
Generic Function: (setf external-format-decoding-table) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: external-format-decoding-table (FLEXI-8-BIT-FORMAT flexi-8-bit-format)

automatically generated reader method

Source

external-format.lisp (file)

Method: (setf external-format-decoding-table) NEW-VALUE (FLEXI-8-BIT-FORMAT flexi-8-bit-format)

automatically generated writer method

Source

external-format.lisp (file)

Generic Function: external-format-encoding-hash OBJECT
Generic Function: (setf external-format-encoding-hash) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: external-format-encoding-hash (FLEXI-8-BIT-FORMAT flexi-8-bit-format)

automatically generated reader method

Source

external-format.lisp (file)

Method: (setf external-format-encoding-hash) NEW-VALUE (FLEXI-8-BIT-FORMAT flexi-8-bit-format)

automatically generated writer method

Source

external-format.lisp (file)

Generic Function: flexi-stream-last-char-code OBJECT
Generic Function: (setf flexi-stream-last-char-code) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: flexi-stream-last-char-code (FLEXI-INPUT-STREAM flexi-input-stream)
Method: (setf flexi-stream-last-char-code) NEW-VALUE (FLEXI-INPUT-STREAM flexi-input-stream)

This slot either holds NIL or the
last character (code) read successfully. This is mainly used for UNREAD-CHAR sanity checks.

Source

stream.lisp (file)

Generic Function: flexi-stream-last-octet OBJECT
Generic Function: (setf flexi-stream-last-octet) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: flexi-stream-last-octet (FLEXI-INPUT-STREAM flexi-input-stream)
Method: (setf flexi-stream-last-octet) NEW-VALUE (FLEXI-INPUT-STREAM flexi-input-stream)

This slot either holds NIL or the last
octet read successfully from the stream using a ‘binary’ operation such as READ-BYTE. This is mainly used for UNREAD-BYTE sanity checks.

Source

stream.lisp (file)

Generic Function: flexi-stream-octet-stack OBJECT
Generic Function: (setf flexi-stream-octet-stack) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: flexi-stream-octet-stack (FLEXI-INPUT-STREAM flexi-input-stream)
Method: (setf flexi-stream-octet-stack) NEW-VALUE (FLEXI-INPUT-STREAM flexi-input-stream)

A small buffer which holds octets
that were already read from the underlying stream but not yet used to produce characters. This is mainly used if we have to look ahead for a CR/LF line ending.

Source

stream.lisp (file)

Generic Function: in-memory-stream-transformer OBJECT
Generic Function: (setf in-memory-stream-transformer) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: in-memory-stream-transformer (IN-MEMORY-STREAM in-memory-stream)
Method: (setf in-memory-stream-transformer) NEW-VALUE (IN-MEMORY-STREAM in-memory-stream)

A function used to transform the
written/read octet to the value stored/retrieved in/from the underlying vector.

Source

in-memory.lisp (file)

Generic Function: list-stream-list OBJECT
Generic Function: (setf list-stream-list) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: list-stream-list (LIST-STREAM list-stream)
Method: (setf list-stream-list) NEW-VALUE (LIST-STREAM list-stream)

The underlying list of the stream.

Source

in-memory.lisp (file)

Generic Function: octets-to-char-code FORMAT READER

Converts a sequence of octets to a character code
(which is returned, or NIL in case of EOF) using the external format FORMAT. The sequence is obtained by calling the function (which must be a functional object) READER with no arguments which should return one octet per call. In the case of EOF, READER should return NIL.

The special variable *CURRENT-UNREADER* must be bound correctly whenever this function is called.

Package

flexi-streams

Source

decode.lisp (file)

Methods
Method: octets-to-char-code (FORMAT flexi-crlf-mixin) READER
Method: octets-to-char-code (FORMAT flexi-cr-mixin) READER
Method: octets-to-char-code (FORMAT flexi-utf-32-be-format) READER
Method: octets-to-char-code (FORMAT flexi-utf-32-le-format) READER
Method: octets-to-char-code (FORMAT flexi-utf-16-be-format) READER
Method: octets-to-char-code (FORMAT flexi-utf-16-le-format) READER
Method: octets-to-char-code (FORMAT flexi-utf-8-format) READER
Method: octets-to-char-code (FORMAT flexi-8-bit-format) READER
Method: octets-to-char-code (FORMAT flexi-ascii-format) READER
Method: octets-to-char-code (FORMAT flexi-latin-1-format) READER
Generic Function: octets-to-string* FORMAT SEQUENCE START END

A generic function which dispatches on the external format and does the real work for OCTETS-TO-STRING.

Package

flexi-streams

Source

decode.lisp (file)

Methods
Method: octets-to-string* (FORMAT flexi-crlf-utf-32-be-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-cr-utf-32-be-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-utf-32-be-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-crlf-utf-32-le-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-cr-utf-32-le-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-utf-32-le-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-crlf-utf-16-be-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-cr-utf-16-be-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-utf-16-be-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-crlf-utf-16-le-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-cr-utf-16-le-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-utf-16-le-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-crlf-utf-8-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-cr-utf-8-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-utf-8-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-crlf-8-bit-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-cr-8-bit-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-8-bit-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-crlf-ascii-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-cr-ascii-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-ascii-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-crlf-latin-1-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-cr-latin-1-format) SEQUENCE START END
Method: octets-to-string* (FORMAT flexi-latin-1-format) SEQUENCE START END
Method: octets-to-string* FORMAT (LIST list) START END around
Generic Function: read-byte* FLEXI-INPUT-STREAM
Package

flexi-streams

Methods
Method: read-byte* (FLEXI-INPUT-STREAM flexi-input-stream)

Reads one byte (octet) from the underlying stream of FLEXI-OUTPUT-STREAM (or from the internal stack if it’s not empty).

Source

input.lisp (file)

Generic Function: read-sequence* FORMAT FLEXI-INPUT-STREAM SEQUENCE START END
Package

flexi-streams

Methods
Method: read-sequence* (FORMAT flexi-crlf-utf-32-be-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-cr-utf-32-be-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-utf-32-be-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-crlf-utf-32-le-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-cr-utf-32-le-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-utf-32-le-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-crlf-utf-16-be-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-cr-utf-16-be-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-utf-16-be-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-crlf-utf-16-le-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-cr-utf-16-le-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-utf-16-le-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-crlf-utf-8-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-cr-utf-8-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-utf-8-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-crlf-8-bit-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-cr-8-bit-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-8-bit-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-crlf-ascii-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-cr-ascii-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-ascii-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-crlf-latin-1-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-cr-latin-1-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Method: read-sequence* (FORMAT flexi-latin-1-format) FLEXI-INPUT-STREAM SEQUENCE START END
Source

decode.lisp (file)

Generic Function: reset-input-state FLEXI-IO-STREAM
Package

flexi-streams

Methods
Method: reset-input-state (FLEXI-IO-STREAM flexi-io-stream)

This method is used to clear any state associated with previous input before output is attempted on the stream. It can fail if the octet stack is not empty and the stream can’t be ‘rewound’.

Source

io.lisp (file)

Generic Function: reset-output-state FLEXI-IO-STREAM
Package

flexi-streams

Methods
Method: reset-output-state (FLEXI-IO-STREAM flexi-io-stream)

This method is used to clear any state associated with previous output before the stream is used for input.

Source

io.lisp (file)

Generic Function: string-to-octets* FORMAT STRING START END

A generic function which dispatches on the external format and does the real work for STRING-TO-OCTETS.

Package

flexi-streams

Source

encode.lisp (file)

Methods
Method: string-to-octets* (FORMAT flexi-crlf-utf-32-be-format) STRING START END
Method: string-to-octets* (FORMAT flexi-cr-utf-32-be-format) STRING START END
Method: string-to-octets* (FORMAT flexi-utf-32-be-format) STRING START END
Method: string-to-octets* (FORMAT flexi-crlf-utf-32-le-format) STRING START END
Method: string-to-octets* (FORMAT flexi-cr-utf-32-le-format) STRING START END
Method: string-to-octets* (FORMAT flexi-utf-32-le-format) STRING START END
Method: string-to-octets* (FORMAT flexi-crlf-utf-16-be-format) STRING START END
Method: string-to-octets* (FORMAT flexi-cr-utf-16-be-format) STRING START END
Method: string-to-octets* (FORMAT flexi-utf-16-be-format) STRING START END
Method: string-to-octets* (FORMAT flexi-crlf-utf-16-le-format) STRING START END
Method: string-to-octets* (FORMAT flexi-cr-utf-16-le-format) STRING START END
Method: string-to-octets* (FORMAT flexi-utf-16-le-format) STRING START END
Method: string-to-octets* (FORMAT flexi-crlf-utf-8-format) STRING START END
Method: string-to-octets* (FORMAT flexi-cr-utf-8-format) STRING START END
Method: string-to-octets* (FORMAT flexi-utf-8-format) STRING START END
Method: string-to-octets* (FORMAT flexi-crlf-8-bit-format) STRING START END
Method: string-to-octets* (FORMAT flexi-cr-8-bit-format) STRING START END
Method: string-to-octets* (FORMAT flexi-8-bit-format) STRING START END
Method: string-to-octets* (FORMAT flexi-crlf-ascii-format) STRING START END
Method: string-to-octets* (FORMAT flexi-cr-ascii-format) STRING START END
Method: string-to-octets* (FORMAT flexi-ascii-format) STRING START END
Method: string-to-octets* (FORMAT flexi-crlf-latin-1-format) STRING START END
Method: string-to-octets* (FORMAT flexi-cr-latin-1-format) STRING START END
Method: string-to-octets* (FORMAT flexi-latin-1-format) STRING START END
Method: string-to-octets* FORMAT (LIST list) START END around
Generic Function: transform-octet STREAM OCTET
Package

flexi-streams

Methods
Method: transform-octet (STREAM in-memory-stream) OCTET

Applies the transformer of STREAM to octet and returns the result.

Source

in-memory.lisp (file)

Generic Function: vector-stream-end OBJECT
Generic Function: (setf vector-stream-end) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: vector-stream-end (VECTOR-INPUT-STREAM vector-input-stream)
Method: (setf vector-stream-end) NEW-VALUE (VECTOR-INPUT-STREAM vector-input-stream)

An index into the underlying vector denoting the end of the available data.

Source

in-memory.lisp (file)

Generic Function: vector-stream-index OBJECT
Generic Function: (setf vector-stream-index) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: vector-stream-index (VECTOR-INPUT-STREAM vector-input-stream)
Method: (setf vector-stream-index) NEW-VALUE (VECTOR-INPUT-STREAM vector-input-stream)

An index into the underlying vector denoting the current position.

Source

in-memory.lisp (file)

Generic Function: vector-stream-vector OBJECT
Generic Function: (setf vector-stream-vector) NEW-VALUE OBJECT
Package

flexi-streams

Methods
Method: vector-stream-vector (VECTOR-STREAM vector-stream)
Method: (setf vector-stream-vector) NEW-VALUE (VECTOR-STREAM vector-stream)

The underlying vector of the stream which
(for output) must always be adjustable and have a fill pointer.

Source

in-memory.lisp (file)

Generic Function: write-byte* BYTE STREAM

Writes one byte (octet) to the underlying stream STREAM.

Package

flexi-streams

Source

output.lisp (file)

Methods
Method: write-byte* BYTE (STREAM flexi-io-stream) after

Keep POSITION slot up to date even when performing output.

Source

io.lisp (file)

Method: write-byte* BYTE (FLEXI-OUTPUT-STREAM flexi-output-stream)
Generic Function: write-sequence* FORMAT STREAM SEQUENCE START END

A generic function which dispatches on the external format and does the real work for STREAM-WRITE-SEQUENCE.

Package

flexi-streams

Source

encode.lisp (file)

Methods
Method: write-sequence* (FORMAT flexi-crlf-utf-32-be-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-cr-utf-32-be-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-utf-32-be-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-crlf-utf-32-le-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-cr-utf-32-le-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-utf-32-le-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-crlf-utf-16-be-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-cr-utf-16-be-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-utf-16-be-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-crlf-utf-16-le-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-cr-utf-16-le-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-utf-16-le-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-crlf-utf-8-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-cr-utf-8-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-utf-8-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-crlf-8-bit-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-cr-8-bit-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-8-bit-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-crlf-ascii-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-cr-ascii-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-ascii-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-crlf-latin-1-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-cr-latin-1-format) STREAM SEQUENCE START END
Method: write-sequence* (FORMAT flexi-latin-1-format) STREAM SEQUENCE START END

Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.6 Conditions

Condition: flexi-stream-simple-error ()

Like FLEXI-STREAM-ERROR but with formatting capabilities.

Package

flexi-streams

Source

conditions.lisp (file)

Direct superclasses
Condition: in-memory-stream-simple-error ()

Like IN-MEMORY-STREAM-ERROR but with formatting capabilities.

Package

flexi-streams

Source

conditions.lisp (file)

Direct superclasses
Direct subclasses

in-memory-stream-position-spec-error (condition)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.7 Classes

Class: external-format ()

EXTERNAL-FORMAT objects are used to denote
encodings for flexi streams or for the string functions defined in strings.lisp.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: name

The name of the external format - a keyword.

Initargs

:name

Readers

external-format-name (generic function)

Slot: id

If the external format denotes a Windows
code page this ID specifies which one to use. Otherwise the value is ignored (and usually NIL).

Initargs

:id

Readers

external-format-id (generic function)

Slot: little-endian

Whether multi-octet values are
read and written with the least significant octet first. For 8-bit encodings like :ISO-8859-1 this value is ignored.

Initargs

:little-endian

Initform

flexi-streams:*default-little-endian*

Readers

external-format-little-endian (generic function)

Slot: eol-style

The character(s) to or from which
a #Newline will be translated - one of the keywords :CR, :LF, or :CRLF.

Initargs

:eol-style

Readers

external-format-eol-style (generic function)

Class: flexi-8-bit-format ()

The class for all flexi streams which use an 8-bit
encoding and thus need additional slots for the encoding/decoding tables.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses

external-format (class)

Direct subclasses
Direct methods
Direct slots
Slot: encoding-hash
Readers

external-format-encoding-hash (generic function)

Writers

(setf external-format-encoding-hash) (generic function)

Slot: decoding-table
Readers

external-format-decoding-table (generic function)

Writers

(setf external-format-decoding-table) (generic function)

Class: flexi-ascii-format ()

Special class for external formats which use the US-ASCII encoding.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses

flexi-8-bit-format (class)

Direct subclasses
Direct methods
Class: flexi-cr-8-bit-format ()

Special class for external formats which use an
8-bit encoding /and/ have #Return as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-cr-ascii-format ()

Special class for external formats which use the
US-ASCII encoding /and/ have #Return as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-cr-latin-1-format ()

Special class for external formats which use the
ISO-8859-1 encoding /and/ have #Return as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-cr-mixin ()

A mixin for external-formats where the end-of-line designator is #Return.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Class: flexi-cr-utf-16-be-format ()

Special class for external formats which use the
UTF-16 encoding with big-endian byte ordering /and/ have #Return as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-cr-utf-16-le-format ()

Special class for external formats which use the
UTF-16 encoding with little-endian byte ordering /and/ have #Return as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-cr-utf-32-be-format ()

Special class for external formats which use the
UTF-32 encoding with big-endian byte ordering /and/ have #Return as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-cr-utf-32-le-format ()

Special class for external formats which use the
UTF-32 encoding with little-endian byte ordering /and/ have #Return as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-cr-utf-8-format ()

Special class for external formats which use the
UTF-8 encoding /and/ have #Return as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-crlf-8-bit-format ()

Special class for external formats which use an
8-bit encoding /and/ have the sequence #Return #Linefeed as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-crlf-ascii-format ()

Special class for external formats which use the
US-ASCII encoding /and/ have the sequence #Return #Linefeed as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-crlf-latin-1-format ()

Special class for external formats which use the
ISO-8859-1 encoding /and/ have the sequence #Return #Linefeed as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-crlf-mixin ()

A mixin for external-formats where the end-of-line designator is the sequence #Return #Linefeed.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Class: flexi-crlf-utf-16-be-format ()

Special class for external formats which use the
UTF-16 encoding with big-endian byte ordering /and/ have the sequence #Return #Linefeed as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-crlf-utf-16-le-format ()

Special class for external formats which use the
UTF-16 encoding with little-endian byte ordering /and/ have the sequence #Return #Linefeed as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-crlf-utf-32-be-format ()

Special class for external formats which use the
the UTF-32 encoding with big-endian byte ordering /and/ have the sequence #Return #Linefeed as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-crlf-utf-32-le-format ()

Special class for external formats which use the
UTF-32 encoding with little-endian byte ordering /and/ have the sequence #Return #Linefeed as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-crlf-utf-8-format ()

Special class for external formats which use the
UTF-8 encoding /and/ have the sequence #Return #Linefeed as the line-end character.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses
Direct methods
Class: flexi-latin-1-format ()

Special class for external formats which use the ISO-8859-1 encoding.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses

flexi-8-bit-format (class)

Direct subclasses
Direct methods
Class: flexi-utf-16-be-format ()

Special class for external formats which use the UTF-16 encoding with big-endian byte ordering.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses

flexi-utf-16-format (class)

Direct subclasses
Direct methods
Class: flexi-utf-16-format ()

Abstract class for external formats which use the UTF-16 encoding.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses

external-format (class)

Direct subclasses
Direct methods
Class: flexi-utf-16-le-format ()

Special class for external formats which use the UTF-16 encoding with little-endian byte ordering.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses

flexi-utf-16-format (class)

Direct subclasses
Direct methods
Class: flexi-utf-32-be-format ()

Special class for external formats which use the UTF-32 encoding with big-endian byte ordering.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses

flexi-utf-32-format (class)

Direct subclasses
Direct methods
Class: flexi-utf-32-format ()

Abstract class for external formats which use the UTF-32 encoding.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses

external-format (class)

Direct subclasses
Direct methods
Class: flexi-utf-32-le-format ()

Special class for external formats which use the UTF-32 encoding with little-endian byte ordering.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses

flexi-utf-32-format (class)

Direct subclasses
Direct methods
Class: flexi-utf-8-format ()

Special class for external formats which use the UTF-8 encoding.

Package

flexi-streams

Source

external-format.lisp (file)

Direct superclasses

external-format (class)

Direct subclasses
Direct methods
Class: list-input-stream ()

A binary input stream that gets its data from an associated list of octets.

Package

flexi-streams

Source

in-memory.lisp (file)

Direct superclasses
Direct methods
  • stream-read-sequence (method)
  • stream-listen (method)
  • stream-read-byte (method)
Class: vector-input-stream ()

A binary input stream that gets its data from an associated vector of octets.

Package

flexi-streams

Source

in-memory.lisp (file)

Direct superclasses
Direct methods
  • stream-file-position (method)
  • stream-file-position (method)
  • stream-read-sequence (method)
  • stream-listen (method)
  • stream-read-byte (method)
  • vector-stream-end (method)
  • vector-stream-end (method)
  • vector-stream-index (method)
  • vector-stream-index (method)
Direct slots
Slot: index

An index into the underlying vector denoting the current position.

Type

(integer 0 4611686018427387901)

Initargs

:index

Readers

vector-stream-index (generic function)

Writers

(setf vector-stream-index) (generic function)

Slot: end

An index into the underlying vector denoting the end of the available data.

Type

(integer 0 4611686018427387901)

Initargs

:end

Readers

vector-stream-end (generic function)

Writers

(setf vector-stream-end) (generic function)

Class: vector-output-stream ()

A binary output stream that writes its data to an associated vector.

Package

flexi-streams

Source

in-memory.lisp (file)

Direct superclasses
Direct methods
  • stream-file-position (method)
  • stream-file-position (method)
  • stream-write-sequence (method)
  • stream-write-byte (method)

Previous: , Up: Internal definitions   [Contents][Index]

5.2.8 Types

Type: char* ()

Convenience shortcut to paper over the difference between LispWorks and the other Lisps.

Package

flexi-streams

Source

mapping.lisp (file)

Type: char-code-integer ()

The subtype of integers which can be returned by the function CHAR-CODE.

Package

flexi-streams

Source

mapping.lisp (file)

Type: code-point ()

The subtype of integers that’s just big enough to hold all Unicode codepoints.

See for example <http://unicode.org/glossary/#C>.

Package

flexi-streams

Source

mapping.lisp (file)

Type: string* ()

Convenience shortcut to paper over the difference between LispWorks and the other Lisps.

Package

flexi-streams

Source

mapping.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L  
Index Entry  Section

F
File, Lisp, flexi-streams.asd: The flexi-streams<dot>asd file
File, Lisp, flexi-streams/ascii.lisp: The flexi-streams/ascii<dot>lisp file
File, Lisp, flexi-streams/code-pages.lisp: The flexi-streams/code-pages<dot>lisp file
File, Lisp, flexi-streams/conditions.lisp: The flexi-streams/conditions<dot>lisp file
File, Lisp, flexi-streams/decode.lisp: The flexi-streams/decode<dot>lisp file
File, Lisp, flexi-streams/encode.lisp: The flexi-streams/encode<dot>lisp file
File, Lisp, flexi-streams/external-format.lisp: The flexi-streams/external-format<dot>lisp file
File, Lisp, flexi-streams/in-memory.lisp: The flexi-streams/in-memory<dot>lisp file
File, Lisp, flexi-streams/input.lisp: The flexi-streams/input<dot>lisp file
File, Lisp, flexi-streams/io.lisp: The flexi-streams/io<dot>lisp file
File, Lisp, flexi-streams/iso-8859.lisp: The flexi-streams/iso-8859<dot>lisp file
File, Lisp, flexi-streams/koi8-r.lisp: The flexi-streams/koi8-r<dot>lisp file
File, Lisp, flexi-streams/length.lisp: The flexi-streams/length<dot>lisp file
File, Lisp, flexi-streams/mapping.lisp: The flexi-streams/mapping<dot>lisp file
File, Lisp, flexi-streams/output.lisp: The flexi-streams/output<dot>lisp file
File, Lisp, flexi-streams/packages.lisp: The flexi-streams/packages<dot>lisp file
File, Lisp, flexi-streams/specials.lisp: The flexi-streams/specials<dot>lisp file
File, Lisp, flexi-streams/stream.lisp: The flexi-streams/stream<dot>lisp file
File, Lisp, flexi-streams/strings.lisp: The flexi-streams/strings<dot>lisp file
File, Lisp, flexi-streams/util.lisp: The flexi-streams/util<dot>lisp file
flexi-streams.asd: The flexi-streams<dot>asd file
flexi-streams/ascii.lisp: The flexi-streams/ascii<dot>lisp file
flexi-streams/code-pages.lisp: The flexi-streams/code-pages<dot>lisp file
flexi-streams/conditions.lisp: The flexi-streams/conditions<dot>lisp file
flexi-streams/decode.lisp: The flexi-streams/decode<dot>lisp file
flexi-streams/encode.lisp: The flexi-streams/encode<dot>lisp file
flexi-streams/external-format.lisp: The flexi-streams/external-format<dot>lisp file
flexi-streams/in-memory.lisp: The flexi-streams/in-memory<dot>lisp file
flexi-streams/input.lisp: The flexi-streams/input<dot>lisp file
flexi-streams/io.lisp: The flexi-streams/io<dot>lisp file
flexi-streams/iso-8859.lisp: The flexi-streams/iso-8859<dot>lisp file
flexi-streams/koi8-r.lisp: The flexi-streams/koi8-r<dot>lisp file
flexi-streams/length.lisp: The flexi-streams/length<dot>lisp file
flexi-streams/mapping.lisp: The flexi-streams/mapping<dot>lisp file
flexi-streams/output.lisp: The flexi-streams/output<dot>lisp file
flexi-streams/packages.lisp: The flexi-streams/packages<dot>lisp file
flexi-streams/specials.lisp: The flexi-streams/specials<dot>lisp file
flexi-streams/stream.lisp: The flexi-streams/stream<dot>lisp file
flexi-streams/strings.lisp: The flexi-streams/strings<dot>lisp file
flexi-streams/util.lisp: The flexi-streams/util<dot>lisp file

L
Lisp File, flexi-streams.asd: The flexi-streams<dot>asd file
Lisp File, flexi-streams/ascii.lisp: The flexi-streams/ascii<dot>lisp file
Lisp File, flexi-streams/code-pages.lisp: The flexi-streams/code-pages<dot>lisp file
Lisp File, flexi-streams/conditions.lisp: The flexi-streams/conditions<dot>lisp file
Lisp File, flexi-streams/decode.lisp: The flexi-streams/decode<dot>lisp file
Lisp File, flexi-streams/encode.lisp: The flexi-streams/encode<dot>lisp file
Lisp File, flexi-streams/external-format.lisp: The flexi-streams/external-format<dot>lisp file
Lisp File, flexi-streams/in-memory.lisp: The flexi-streams/in-memory<dot>lisp file
Lisp File, flexi-streams/input.lisp: The flexi-streams/input<dot>lisp file
Lisp File, flexi-streams/io.lisp: The flexi-streams/io<dot>lisp file
Lisp File, flexi-streams/iso-8859.lisp: The flexi-streams/iso-8859<dot>lisp file
Lisp File, flexi-streams/koi8-r.lisp: The flexi-streams/koi8-r<dot>lisp file
Lisp File, flexi-streams/length.lisp: The flexi-streams/length<dot>lisp file
Lisp File, flexi-streams/mapping.lisp: The flexi-streams/mapping<dot>lisp file
Lisp File, flexi-streams/output.lisp: The flexi-streams/output<dot>lisp file
Lisp File, flexi-streams/packages.lisp: The flexi-streams/packages<dot>lisp file
Lisp File, flexi-streams/specials.lisp: The flexi-streams/specials<dot>lisp file
Lisp File, flexi-streams/stream.lisp: The flexi-streams/stream<dot>lisp file
Lisp File, flexi-streams/strings.lisp: The flexi-streams/strings<dot>lisp file
Lisp File, flexi-streams/util.lisp: The flexi-streams/util<dot>lisp file

Jump to:   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   C   D   E   F   G   H   I   K   L   M   N   O   P   R   S   T   U   V   W  
Index Entry  Section

(
(setf external-format-decoding-table): Internal generic functions
(setf external-format-decoding-table): Internal generic functions
(setf external-format-encoding-hash): Internal generic functions
(setf external-format-encoding-hash): Internal generic functions
(setf flexi-stream-bound): Exported generic functions
(setf flexi-stream-bound): Exported generic functions
(setf flexi-stream-column): Exported generic functions
(setf flexi-stream-column): Exported generic functions
(setf flexi-stream-element-type): Exported generic functions
(setf flexi-stream-element-type): Exported generic functions
(setf flexi-stream-element-type): Exported generic functions
(setf flexi-stream-external-format): Exported generic functions
(setf flexi-stream-external-format): Exported generic functions
(setf flexi-stream-external-format): Exported generic functions
(setf flexi-stream-last-char-code): Internal generic functions
(setf flexi-stream-last-char-code): Internal generic functions
(setf flexi-stream-last-octet): Internal generic functions
(setf flexi-stream-last-octet): Internal generic functions
(setf flexi-stream-octet-stack): Internal generic functions
(setf flexi-stream-octet-stack): Internal generic functions
(setf flexi-stream-position): Exported generic functions
(setf flexi-stream-position): Exported generic functions
(setf in-memory-stream-transformer): Internal generic functions
(setf in-memory-stream-transformer): Internal generic functions
(setf list-stream-list): Internal generic functions
(setf list-stream-list): Internal generic functions
(setf vector-stream-end): Internal generic functions
(setf vector-stream-end): Internal generic functions
(setf vector-stream-index): Internal generic functions
(setf vector-stream-index): Internal generic functions
(setf vector-stream-vector): Internal generic functions
(setf vector-stream-vector): Internal generic functions

A
ascii-name-p: Internal functions
ash*: Internal macros

C
char-length: Exported functions
char-to-octets: Internal generic functions
char-to-octets: Internal generic functions
char-to-octets: Internal generic functions
char-to-octets: Internal generic functions
char-to-octets: Internal generic functions
char-to-octets: Internal generic functions
char-to-octets: Internal generic functions
char-to-octets: Internal generic functions
char-to-octets: Internal generic functions
char-to-octets: Internal generic functions
char-to-octets: Internal generic functions
character-length: Internal generic functions
character-length: Internal generic functions
character-length: Internal generic functions
character-length: Internal generic functions
character-length: Internal generic functions
check-end: Internal generic functions
check-end: Internal generic functions
check-end: Internal generic functions
check-if-open: Internal generic functions
check-if-open: Internal generic functions
code-page-name-p: Internal functions
compute-number-of-chars: Internal generic functions
compute-number-of-chars: Internal generic functions
compute-number-of-chars: Internal generic functions
compute-number-of-chars: Internal generic functions
compute-number-of-chars: Internal generic functions
compute-number-of-chars: Internal generic functions
compute-number-of-chars: Internal generic functions
compute-number-of-chars: Internal generic functions
compute-number-of-chars: Internal generic functions
compute-number-of-chars: Internal generic functions
compute-number-of-chars: Internal generic functions
compute-number-of-chars: Internal generic functions
compute-number-of-chars: Internal generic functions
compute-number-of-chars: Internal generic functions
compute-number-of-chars: Internal generic functions
compute-number-of-octets: Internal generic functions
compute-number-of-octets: Internal generic functions
compute-number-of-octets: Internal generic functions
compute-number-of-octets: Internal generic functions
compute-number-of-octets: Internal generic functions
compute-number-of-octets: Internal generic functions
compute-number-of-octets: Internal generic functions
compute-number-of-octets: Internal generic functions
compute-number-of-octets: Internal generic functions
compute-number-of-octets: Internal generic functions

D
defconstant: Internal macros
define-char-decoders: Internal macros
define-char-encoders: Internal macros
define-sequence-readers: Internal macros
define-sequence-writers: Internal macros

E
encoding-factor: Internal generic functions
encoding-factor: Internal generic functions
encoding-factor: Internal generic functions
encoding-factor: Internal generic functions
encoding-factor: Internal generic functions
encoding-factor: Internal generic functions
external-format-class-name: Internal functions
external-format-condition-external-format: Exported generic functions
external-format-condition-external-format: Exported generic functions
external-format-decoding-table: Internal generic functions
external-format-decoding-table: Internal generic functions
external-format-encoding-hash: Internal generic functions
external-format-encoding-hash: Internal generic functions
external-format-eol-style: Exported generic functions
external-format-eol-style: Exported generic functions
external-format-equal: Exported functions
external-format-id: Exported generic functions
external-format-id: Exported generic functions
external-format-little-endian: Exported generic functions
external-format-little-endian: Exported generic functions
external-format-name: Exported generic functions
external-format-name: Exported generic functions

F
flexi-stream-bound: Exported generic functions
flexi-stream-bound: Exported generic functions
flexi-stream-column: Exported generic functions
flexi-stream-column: Exported generic functions
flexi-stream-element-type: Exported generic functions
flexi-stream-element-type: Exported generic functions
flexi-stream-element-type-error-element-type: Exported generic functions
flexi-stream-element-type-error-element-type: Exported generic functions
flexi-stream-external-format: Exported generic functions
flexi-stream-external-format: Exported generic functions
flexi-stream-last-char-code: Internal generic functions
flexi-stream-last-char-code: Internal generic functions
flexi-stream-last-octet: Internal generic functions
flexi-stream-last-octet: Internal generic functions
flexi-stream-octet-stack: Internal generic functions
flexi-stream-octet-stack: Internal generic functions
flexi-stream-position: Exported generic functions
flexi-stream-position: Exported generic functions
flexi-stream-stream: Exported generic functions
flexi-stream-stream: Exported generic functions
Function, ascii-name-p: Internal functions
Function, char-length: Exported functions
Function, code-page-name-p: Internal functions
Function, external-format-class-name: Internal functions
Function, external-format-equal: Exported functions
Function, hyperdoc-lookup: Internal functions
Function, invert-table: Internal functions
Function, iso-8859-name-p: Internal functions
Function, known-code-page-id-p: Internal functions
Function, koi8-r-name-p: Internal functions
Function, make-decoding-table: Internal functions
Function, make-external-format: Exported functions
Function, make-external-format%: Internal functions
Function, make-flexi-stream: Exported functions
Function, make-in-memory-output-stream: Exported functions
Function, make-octet-buffer: Internal functions
Function, make-output-vector: Internal functions
Function, maybe-convert-external-format: Internal functions
Function, maybe-rewind: Internal functions
Function, normalize-external-format: Internal functions
Function, normalize-external-format-name: Internal functions
Function, octet-length: Exported functions
Function, octets-to-string: Exported functions
Function, recover-from-encoding-error: Internal functions
Function, sans: Internal functions
Function, signal-encoding-error: Internal functions
Function, string-to-octets: Exported functions
Function, type-equal: Internal functions
Function, unread-char%: Internal functions

G
Generic Function, (setf external-format-decoding-table): Internal generic functions
Generic Function, (setf external-format-encoding-hash): Internal generic functions
Generic Function, (setf flexi-stream-bound): Exported generic functions
Generic Function, (setf flexi-stream-column): Exported generic functions
Generic Function, (setf flexi-stream-element-type): Exported generic functions
Generic Function, (setf flexi-stream-external-format): Exported generic functions
Generic Function, (setf flexi-stream-last-char-code): Internal generic functions
Generic Function, (setf flexi-stream-last-octet): Internal generic functions
Generic Function, (setf flexi-stream-octet-stack): Internal generic functions
Generic Function, (setf flexi-stream-position): Exported generic functions
Generic Function, (setf in-memory-stream-transformer): Internal generic functions
Generic Function, (setf list-stream-list): Internal generic functions
Generic Function, (setf vector-stream-end): Internal generic functions
Generic Function, (setf vector-stream-index): Internal generic functions
Generic Function, (setf vector-stream-vector): Internal generic functions
Generic Function, char-to-octets: Internal generic functions
Generic Function, character-length: Internal generic functions
Generic Function, check-end: Internal generic functions
Generic Function, check-if-open: Internal generic functions
Generic Function, compute-number-of-chars: Internal generic functions
Generic Function, compute-number-of-octets: Internal generic functions
Generic Function, encoding-factor: Internal generic functions
Generic Function, external-format-condition-external-format: Exported generic functions
Generic Function, external-format-decoding-table: Internal generic functions
Generic Function, external-format-encoding-hash: Internal generic functions
Generic Function, external-format-eol-style: Exported generic functions
Generic Function, external-format-id: Exported generic functions
Generic Function, external-format-little-endian: Exported generic functions
Generic Function, external-format-name: Exported generic functions
Generic Function, flexi-stream-bound: Exported generic functions
Generic Function, flexi-stream-column: Exported generic functions
Generic Function, flexi-stream-element-type: Exported generic functions
Generic Function, flexi-stream-element-type-error-element-type: Exported generic functions
Generic Function, flexi-stream-external-format: Exported generic functions
Generic Function, flexi-stream-last-char-code: Internal generic functions
Generic Function, flexi-stream-last-octet: Internal generic functions
Generic Function, flexi-stream-octet-stack: Internal generic functions
Generic Function, flexi-stream-position: Exported generic functions
Generic Function, flexi-stream-stream: Exported generic functions
Generic Function, get-output-stream-sequence: Exported generic functions
Generic Function, in-memory-stream-position-spec-error-position-spec: Exported generic functions
Generic Function, in-memory-stream-transformer: Internal generic functions
Generic Function, list-stream-list: Internal generic functions
Generic Function, make-in-memory-input-stream: Exported generic functions
Generic Function, octets-to-char-code: Internal generic functions
Generic Function, octets-to-string*: Internal generic functions
Generic Function, output-stream-sequence-length: Exported generic functions
Generic Function, peek-byte: Exported generic functions
Generic Function, read-byte*: Internal generic functions
Generic Function, read-sequence*: Internal generic functions
Generic Function, reset-input-state: Internal generic functions
Generic Function, reset-output-state: Internal generic functions
Generic Function, string-to-octets*: Internal generic functions
Generic Function, transform-octet: Internal generic functions
Generic Function, unread-byte: Exported generic functions
Generic Function, vector-stream-end: Internal generic functions
Generic Function, vector-stream-index: Internal generic functions
Generic Function, vector-stream-vector: Internal generic functions
Generic Function, write-byte*: Internal generic functions
Generic Function, write-sequence*: Internal generic functions
get-output-stream-sequence: Exported generic functions
get-output-stream-sequence: Exported generic functions

H
hyperdoc-lookup: Internal functions

I
in-memory-stream-position-spec-error-position-spec: Exported generic functions
in-memory-stream-position-spec-error-position-spec: Exported generic functions
in-memory-stream-transformer: Internal generic functions
in-memory-stream-transformer: Internal generic functions
invert-table: Internal functions
iso-8859-name-p: Internal functions

K
known-code-page-id-p: Internal functions
koi8-r-name-p: Internal functions

L
list-stream-list: Internal generic functions
list-stream-list: Internal generic functions
logand*: Internal macros
logior*: Internal macros

M
Macro, ash*: Internal macros
Macro, defconstant: Internal macros
Macro, define-char-decoders: Internal macros
Macro, define-char-encoders: Internal macros
Macro, define-sequence-readers: Internal macros
Macro, define-sequence-writers: Internal macros
Macro, logand*: Internal macros
Macro, logior*: Internal macros
Macro, when-let: Internal macros
Macro, with-input-from-sequence: Exported macros
Macro, with-output-to-sequence: Exported macros
Macro, with-rebinding: Internal macros
Macro, with-unique-names: Internal macros
make-decoding-table: Internal functions
make-external-format: Exported functions
make-external-format%: Internal functions
make-flexi-stream: Exported functions
make-in-memory-input-stream: Exported generic functions
make-in-memory-input-stream: Exported generic functions
make-in-memory-input-stream: Exported generic functions
make-in-memory-output-stream: Exported functions
make-octet-buffer: Internal functions
make-output-vector: Internal functions
maybe-convert-external-format: Internal functions
maybe-rewind: Internal functions
Method, (setf external-format-decoding-table): Internal generic functions
Method, (setf external-format-encoding-hash): Internal generic functions
Method, (setf flexi-stream-bound): Exported generic functions
Method, (setf flexi-stream-column): Exported generic functions
Method, (setf flexi-stream-element-type): Exported generic functions
Method, (setf flexi-stream-element-type): Exported generic functions
Method, (setf flexi-stream-external-format): Exported generic functions
Method, (setf flexi-stream-external-format): Exported generic functions
Method, (setf flexi-stream-last-char-code): Internal generic functions
Method, (setf flexi-stream-last-octet): Internal generic functions
Method, (setf flexi-stream-octet-stack): Internal generic functions
Method, (setf flexi-stream-position): Exported generic functions
Method, (setf in-memory-stream-transformer): Internal generic functions
Method, (setf list-stream-list): Internal generic functions
Method, (setf vector-stream-end): Internal generic functions
Method, (setf vector-stream-index): Internal generic functions
Method, (setf vector-stream-vector): Internal generic functions
Method, char-to-octets: Internal generic functions
Method, char-to-octets: Internal generic functions
Method, char-to-octets: Internal generic functions
Method, char-to-octets: Internal generic functions
Method, char-to-octets: Internal generic functions
Method, char-to-octets: Internal generic functions
Method, char-to-octets: Internal generic functions
Method, char-to-octets: Internal generic functions
Method, char-to-octets: Internal generic functions
Method, char-to-octets: Internal generic functions
Method, character-length: Internal generic functions
Method, character-length: Internal generic functions
Method, character-length: Internal generic functions
Method, character-length: Internal generic functions
Method, check-end: Internal generic functions
Method, check-end: Internal generic functions
Method, check-if-open: Internal generic functions
Method, compute-number-of-chars: Internal generic functions
Method, compute-number-of-chars: Internal generic functions
Method, compute-number-of-chars: Internal generic functions
Method, compute-number-of-chars: Internal generic functions
Method, compute-number-of-chars: Internal generic functions
Method, compute-number-of-chars: Internal generic functions
Method, compute-number-of-chars: Internal generic functions
Method, compute-number-of-chars: Internal generic functions
Method, compute-number-of-chars: Internal generic functions
Method, compute-number-of-chars: Internal generic functions
Method, compute-number-of-chars: Internal generic functions
Method, compute-number-of-chars: Internal generic functions
Method, compute-number-of-chars: Internal generic functions
Method, compute-number-of-chars: Internal generic functions
Method, compute-number-of-octets: Internal generic functions
Method, compute-number-of-octets: Internal generic functions
Method, compute-number-of-octets: Internal generic functions
Method, compute-number-of-octets: Internal generic functions
Method, compute-number-of-octets: Internal generic functions
Method, compute-number-of-octets: Internal generic functions
Method, compute-number-of-octets: Internal generic functions
Method, compute-number-of-octets: Internal generic functions
Method, compute-number-of-octets: Internal generic functions
Method, encoding-factor: Internal generic functions
Method, encoding-factor: Internal generic functions
Method, encoding-factor: Internal generic functions
Method, encoding-factor: Internal generic functions
Method, encoding-factor: Internal generic functions
Method, external-format-condition-external-format: Exported generic functions
Method, external-format-decoding-table: Internal generic functions
Method, external-format-encoding-hash: Internal generic functions
Method, external-format-eol-style: Exported generic functions
Method, external-format-id: Exported generic functions
Method, external-format-little-endian: Exported generic functions
Method, external-format-name: Exported generic functions
Method, flexi-stream-bound: Exported generic functions
Method, flexi-stream-column: Exported generic functions
Method, flexi-stream-element-type: Exported generic functions
Method, flexi-stream-element-type-error-element-type: Exported generic functions
Method, flexi-stream-external-format: Exported generic functions
Method, flexi-stream-last-char-code: Internal generic functions
Method, flexi-stream-last-octet: Internal generic functions
Method, flexi-stream-octet-stack: Internal generic functions
Method, flexi-stream-position: Exported generic functions
Method, flexi-stream-stream: Exported generic functions
Method, get-output-stream-sequence: Exported generic functions
Method, in-memory-stream-position-spec-error-position-spec: Exported generic functions
Method, in-memory-stream-transformer: Internal generic functions
Method, list-stream-list: Internal generic functions
Method, make-in-memory-input-stream: Exported generic functions
Method, make-in-memory-input-stream: Exported generic functions
Method, octets-to-char-code: Internal generic functions
Method, octets-to-char-code: Internal generic functions
Method, octets-to-char-code: Internal generic functions
Method, octets-to-char-code: Internal generic functions
Method, octets-to-char-code: Internal generic functions
Method, octets-to-char-code: Internal generic functions
Method, octets-to-char-code: Internal generic functions
Method, octets-to-char-code: Internal generic functions
Method, octets-to-char-code: Internal generic functions
Method, octets-to-char-code: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, octets-to-string*: Internal generic functions
Method, output-stream-sequence-length: Exported generic functions
Method, peek-byte: Exported generic functions
Method, read-byte*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, read-sequence*: Internal generic functions
Method, reset-input-state: Internal generic functions
Method, reset-output-state: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, string-to-octets*: Internal generic functions
Method, transform-octet: Internal generic functions
Method, unread-byte: Exported generic functions
Method, unread-byte: Exported generic functions
Method, vector-stream-end: Internal generic functions
Method, vector-stream-index: Internal generic functions
Method, vector-stream-vector: Internal generic functions
Method, write-byte*: Internal generic functions
Method, write-byte*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions
Method, write-sequence*: Internal generic functions

N
normalize-external-format: Internal functions
normalize-external-format-name: Internal functions

O
octet-length: Exported functions
octets-to-char-code: Internal generic functions
octets-to-char-code: Internal generic functions
octets-to-char-code: Internal generic functions
octets-to-char-code: Internal generic functions
octets-to-char-code: Internal generic functions
octets-to-char-code: Internal generic functions
octets-to-char-code: Internal generic functions
octets-to-char-code: Internal generic functions
octets-to-char-code: Internal generic functions
octets-to-char-code: Internal generic functions
octets-to-char-code: Internal generic functions
octets-to-string: Exported functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
octets-to-string*: Internal generic functions
output-stream-sequence-length: Exported generic functions
output-stream-sequence-length: Exported generic functions

P
peek-byte: Exported generic functions
peek-byte: Exported generic functions

R
read-byte*: Internal generic functions
read-byte*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
read-sequence*: Internal generic functions
recover-from-encoding-error: Internal functions
reset-input-state: Internal generic functions
reset-input-state: Internal generic functions
reset-output-state: Internal generic functions
reset-output-state: Internal generic functions

S
sans: Internal functions
signal-encoding-error: Internal functions
string-to-octets: Exported functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions
string-to-octets*: Internal generic functions

T
transform-octet: Internal generic functions
transform-octet: Internal generic functions
type-equal: Internal functions

U
unread-byte: Exported generic functions
unread-byte: Exported generic functions
unread-byte: Exported generic functions
unread-char%: Internal functions

V
vector-stream-end: Internal generic functions
vector-stream-end: Internal generic functions
vector-stream-index: Internal generic functions
vector-stream-index: Internal generic functions
vector-stream-vector: Internal generic functions
vector-stream-vector: Internal generic functions

W
when-let: Internal macros
with-input-from-sequence: Exported macros
with-output-to-sequence: Exported macros
with-rebinding: Internal macros
with-unique-names: Internal macros
write-byte*: Internal generic functions
write-byte*: Internal generic functions
write-byte*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions
write-sequence*: Internal generic functions

Jump to:   (  
A   C   D   E   F   G   H   I   K   L   M   N   O   P   R   S   T   U   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
B   C   D   E   I   L   N   O   P   S   T   V  
Index Entry  Section

*
*current-unreader*: Internal special variables
*default-eol-style*: Exported special variables
*default-little-endian*: Exported special variables
*fixnum-optimize-settings*: Internal special variables
*hyperdoc-base-uri*: Internal special variables
*standard-optimize-settings*: Internal special variables
*substitution-char*: Exported special variables

+
+ascii-hash+: Internal constants
+ascii-table+: Internal constants
+buffer-size+: Internal constants
+code-page-hashes+: Internal constants
+code-page-tables+: Internal constants
+cr+: Internal constants
+iso-8859-hashes+: Internal constants
+iso-8859-tables+: Internal constants
+koi8-r-hash+: Internal constants
+koi8-r-table+: Internal constants
+lf+: Internal constants
+name-map+: Internal special variables
+shortcut-map+: Internal special variables

B
bound: Exported classes

C
column: Exported classes
Constant, +ascii-hash+: Internal constants
Constant, +ascii-table+: Internal constants
Constant, +buffer-size+: Internal constants
Constant, +code-page-hashes+: Internal constants
Constant, +code-page-tables+: Internal constants
Constant, +cr+: Internal constants
Constant, +iso-8859-hashes+: Internal constants
Constant, +iso-8859-tables+: Internal constants
Constant, +koi8-r-hash+: Internal constants
Constant, +koi8-r-table+: Internal constants
Constant, +lf+: Internal constants

D
decoding-table: Internal classes

E
element-type: Exported conditions
element-type: Exported classes
encoding-hash: Internal classes
end: Internal classes
eol-style: Internal classes
external-format: Exported conditions
external-format: Exported classes

I
id: Internal classes
index: Internal classes

L
last-char-code: Exported classes
last-octet: Exported classes
list: Exported classes
little-endian: Internal classes

N
name: Internal classes

O
octet-stack: Exported classes

P
position: Exported classes
position-spec: Exported conditions

S
Slot, bound: Exported classes
Slot, column: Exported classes
Slot, decoding-table: Internal classes
Slot, element-type: Exported conditions
Slot, element-type: Exported classes
Slot, encoding-hash: Internal classes
Slot, end: Internal classes
Slot, eol-style: Internal classes
Slot, external-format: Exported conditions
Slot, external-format: Exported classes
Slot, id: Internal classes
Slot, index: Internal classes
Slot, last-char-code: Exported classes
Slot, last-octet: Exported classes
Slot, list: Exported classes
Slot, little-endian: Internal classes
Slot, name: Internal classes
Slot, octet-stack: Exported classes
Slot, position: Exported classes
Slot, position-spec: Exported conditions
Slot, stream: Exported classes
Slot, transformer: Exported classes
Slot, vector: Exported classes
Special Variable, *current-unreader*: Internal special variables
Special Variable, *default-eol-style*: Exported special variables
Special Variable, *default-little-endian*: Exported special variables
Special Variable, *fixnum-optimize-settings*: Internal special variables
Special Variable, *hyperdoc-base-uri*: Internal special variables
Special Variable, *standard-optimize-settings*: Internal special variables
Special Variable, *substitution-char*: Exported special variables
Special Variable, +name-map+: Internal special variables
Special Variable, +shortcut-map+: Internal special variables
stream: Exported classes

T
transformer: Exported classes

V
vector: Exported classes

Jump to:   *   +  
B   C   D   E   I   L   N   O   P   S   T   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   E   F   I   L   O   P   S   T   V  
Index Entry  Section

C
char*: Internal types
char-code-integer: Internal types
Class, external-format: Internal classes
Class, flexi-8-bit-format: Internal classes
Class, flexi-ascii-format: Internal classes
Class, flexi-cr-8-bit-format: Internal classes
Class, flexi-cr-ascii-format: Internal classes
Class, flexi-cr-latin-1-format: Internal classes
Class, flexi-cr-mixin: Internal classes
Class, flexi-cr-utf-16-be-format: Internal classes
Class, flexi-cr-utf-16-le-format: Internal classes
Class, flexi-cr-utf-32-be-format: Internal classes
Class, flexi-cr-utf-32-le-format: Internal classes
Class, flexi-cr-utf-8-format: Internal classes
Class, flexi-crlf-8-bit-format: Internal classes
Class, flexi-crlf-ascii-format: Internal classes
Class, flexi-crlf-latin-1-format: Internal classes
Class, flexi-crlf-mixin: Internal classes
Class, flexi-crlf-utf-16-be-format: Internal classes
Class, flexi-crlf-utf-16-le-format: Internal classes
Class, flexi-crlf-utf-32-be-format: Internal classes
Class, flexi-crlf-utf-32-le-format: Internal classes
Class, flexi-crlf-utf-8-format: Internal classes
Class, flexi-input-stream: Exported classes
Class, flexi-io-stream: Exported classes
Class, flexi-latin-1-format: Internal classes
Class, flexi-output-stream: Exported classes
Class, flexi-stream: Exported classes
Class, flexi-utf-16-be-format: Internal classes
Class, flexi-utf-16-format: Internal classes
Class, flexi-utf-16-le-format: Internal classes
Class, flexi-utf-32-be-format: Internal classes
Class, flexi-utf-32-format: Internal classes
Class, flexi-utf-32-le-format: Internal classes
Class, flexi-utf-8-format: Internal classes
Class, in-memory-input-stream: Exported classes
Class, in-memory-output-stream: Exported classes
Class, in-memory-stream: Exported classes
Class, list-input-stream: Internal classes
Class, list-stream: Exported classes
Class, vector-input-stream: Internal classes
Class, vector-output-stream: Internal classes
Class, vector-stream: Exported classes
code-point: Internal types
Condition, external-format-condition: Exported conditions
Condition, external-format-encoding-error: Exported conditions
Condition, external-format-error: Exported conditions
Condition, flexi-stream-element-type-error: Exported conditions
Condition, flexi-stream-error: Exported conditions
Condition, flexi-stream-out-of-sync-error: Exported conditions
Condition, flexi-stream-simple-error: Internal conditions
Condition, in-memory-stream-closed-error: Exported conditions
Condition, in-memory-stream-error: Exported conditions
Condition, in-memory-stream-position-spec-error: Exported conditions
Condition, in-memory-stream-simple-error: Internal conditions

E
external-format: Internal classes
external-format-condition: Exported conditions
external-format-encoding-error: Exported conditions
external-format-error: Exported conditions

F
flexi-8-bit-format: Internal classes
flexi-ascii-format: Internal classes
flexi-cr-8-bit-format: Internal classes
flexi-cr-ascii-format: Internal classes
flexi-cr-latin-1-format: Internal classes
flexi-cr-mixin: Internal classes
flexi-cr-utf-16-be-format: Internal classes
flexi-cr-utf-16-le-format: Internal classes
flexi-cr-utf-32-be-format: Internal classes
flexi-cr-utf-32-le-format: Internal classes
flexi-cr-utf-8-format: Internal classes
flexi-crlf-8-bit-format: Internal classes
flexi-crlf-ascii-format: Internal classes
flexi-crlf-latin-1-format: Internal classes
flexi-crlf-mixin: Internal classes
flexi-crlf-utf-16-be-format: Internal classes
flexi-crlf-utf-16-le-format: Internal classes
flexi-crlf-utf-32-be-format: Internal classes
flexi-crlf-utf-32-le-format: Internal classes
flexi-crlf-utf-8-format: Internal classes
flexi-input-stream: Exported classes
flexi-io-stream: Exported classes
flexi-latin-1-format: Internal classes
flexi-output-stream: Exported classes
flexi-stream: Exported classes
flexi-stream-element-type-error: Exported conditions
flexi-stream-error: Exported conditions
flexi-stream-out-of-sync-error: Exported conditions
flexi-stream-simple-error: Internal conditions
flexi-streams: The flexi-streams system
flexi-streams: The flexi-streams package
flexi-streams-system: The flexi-streams-system package
flexi-utf-16-be-format: Internal classes
flexi-utf-16-format: Internal classes
flexi-utf-16-le-format: Internal classes
flexi-utf-32-be-format: Internal classes
flexi-utf-32-format: Internal classes
flexi-utf-32-le-format: Internal classes
flexi-utf-8-format: Internal classes

I
in-memory-input-stream: Exported classes
in-memory-output-stream: Exported classes
in-memory-stream: Exported classes
in-memory-stream-closed-error: Exported conditions
in-memory-stream-error: Exported conditions
in-memory-stream-position-spec-error: Exported conditions
in-memory-stream-simple-error: Internal conditions

L
list-input-stream: Internal classes
list-stream: Exported classes

O
octet: Exported types

P
Package, flexi-streams: The flexi-streams package
Package, flexi-streams-system: The flexi-streams-system package

S
string*: Internal types
System, flexi-streams: The flexi-streams system

T
Type, char*: Internal types
Type, char-code-integer: Internal types
Type, code-point: Internal types
Type, octet: Exported types
Type, string*: Internal types

V
vector-input-stream: Internal classes
vector-output-stream: Internal classes
vector-stream: Exported classes

Jump to:   C   E   F   I   L   O   P   S   T   V