The sb-vector-io Reference Manual

3.1.1 sb-vector-io/sb-vector-io.asd

Source

sb-vector-io.asd.

Parent Component

sb-vector-io (system).

ASDF Systems

sb-vector-io.

3.1.2 sb-vector-io/package.lisp

Source

sb-vector-io.asd.

Parent Component

sb-vector-io (system).

Packages

• vector-io.
• sb-vector-io.

Public Interface

• read-vector-data (compiler macro).
• read-vector-data (generic function).
• write-vector-data (compiler macro).
• write-vector-data (generic function).

Internals

*notified* (special variable).

3.1.3 sb-vector-io/vector-io.lisp

Dependency

package.lisp (file).

Source

sb-vector-io.asd.

Parent Component

sb-vector-io (system).

Public Interface

• read-vector-data (generic function).
• write-vector-data (generic function).

Internals

• check-stream-element-type (function).
• stream-fd (generic function).
• stream-timeout (generic function).
• vector-element-bytes (function).
• wait-for-vector-write (function).

5.1.1 Compiler macros

Compiler Macro: read-vector-data (&rest args) ¶

Package

vector-io.

Source

package.lisp.

Compiler Macro: write-vector-data (&rest args) ¶

Package

vector-io.

Source

package.lisp.

5.1.2 Generic functions

Generic Function: read-vector-data (vector stream &key start end) ¶

Package

vector-io.

Source

package.lisp.

Methods

Method: read-vector-data (vector stream &key start end) ¶

Generic Function: read-vector-data (vector stream &key start end) ¶

Destructively modifies VECTOR by replacing elements of the subsequence bounded by START and AND with raw data from STREAM.

VECTOR must have ARRAY-ELEMENT-TYPE of DOUBLE-FLOAT, SINGLE-FLOAT, (UNSIGNED-BYTE X), or (SIGNED-BYTE X). Floating point values are
read using the IEEE formats, and SIGNED-BYTE and UNSIGNED-BYTE values
are read as raw bytes using the native endianness of the host
platform. FIXNUMs are read in the implementation internal
representation.

Primary return value is the number of elements read.

If element type of VECTOR is other than (UNSIGNED-BYTE 8) or (SIGNED-BYTE 8), and END-OF-FILE occurs before all the requested elements have been read, the last element read may be incomplete. In such a case the secondary return value is the number of bytes missing from the last element – NIL if the last element is complete.

Package

sb-vector-io.

Source

vector-io.lisp.

Methods

Method: read-vector-data ((vector vector) (stream ansi-stream) &key start end) ¶

Generic Function: write-vector-data (vector stream &key start end) ¶

Package

vector-io.

Source

package.lisp.

Methods

Method: write-vector-data (vector stream &key start end) ¶

Generic Function: write-vector-data (vector stream &key start end) ¶

Writes elements of the subsequence of VECTOR bounded by START and END to STREAM.

VECTOR must have ARRAY-ELEMENT-TYPE of FIXNUM, DOUBLE-FLOAT, SINGLE-FLOAT, (UNSIGNED-BYTE X), or (SIGNED-BYTE X). Floating point values are written using the IEEE formats, and SIGNED-BYTE and UNSIGNED-BYTE values are written as raw bytes using the native endianness of the host platform. FIXNUMs are written in the implementation internal representation.

STREAM must be a binary output stream.

Returns the number of elements written.

Package

sb-vector-io.

Source

vector-io.lisp.

Methods

Method: write-vector-data ((vector vector) (stream ansi-stream) &key start end) ¶

5.2.1 Special variables

Special Variable: *notified* ¶

Package

vector-io.

Source

package.lisp.

5.2.2 Ordinary functions

Function: check-stream-element-type (stream context) ¶

Package

sb-vector-io.

Source

vector-io.lisp.

Function: vector-element-bytes (vector) ¶

Package

sb-vector-io.

Source

vector-io.lisp.

Function: wait-for-vector-write (stream fd data start bytes) ¶

Package

sb-vector-io.

Source

vector-io.lisp.

5.2.3 Generic functions

Generic Function: stream-fd (stream direction) ¶

Returns the underlying file-descriptor of STREAM in DIRECTION. DIRECTION must be either :INPUT or :OUTPUT.

Package

sb-vector-io.

Source

vector-io.lisp.

Methods

Method: stream-fd ((stream fd-stream) direction) ¶

Method: stream-fd ((stream synonym-stream) direction) ¶

Method: stream-fd ((stream two-way-stream) direction) ¶

Generic Function: stream-timeout (stream direction) ¶

Returns the underlying timeout of STREAM in DIRECTION. DIRECTION must be either :INPUT or :OUTPUT.

Package

sb-vector-io.

Source

vector-io.lisp.

Methods

Method: stream-timeout ((stream fd-stream) direction) ¶

Method: stream-timeout ((stream synonym-stream) direction) ¶

Method: stream-timeout ((stream two-way-stream) direction) ¶