The redirect-stream Reference Manual

This is the redirect-stream Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:46:22 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 redirect-stream

Offers a stream that redirects all actions to an inner stream.

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://Shinmera.github.io/redirect-stream/

Source Control

(GIT https://github.com/Shinmera/redirect-stream.git)

Bug Tracker

https://github.com/Shinmera/redirect-stream/issues

License

zlib

Version

1.0.0

Dependency

trivial-gray-streams (system).

Source

redirect-stream.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 redirect-stream/redirect-stream.asd

Source

redirect-stream.asd.

Parent Component

redirect-stream (system).

ASDF Systems

redirect-stream.


3.1.2 redirect-stream/redirect-stream.lisp

Source

redirect-stream.asd.

Parent Component

redirect-stream (system).

Packages

redirect-stream.

Public Interface
Internals

define-redirect-method (macro).


3.1.3 redirect-stream/documentation.lisp

Dependency

redirect-stream.lisp (file).

Source

redirect-stream.asd.

Parent Component

redirect-stream (system).

Internals

setdocs (macro).


4 Packages

Packages are listed by definition order.


4.1 redirect-stream

Source

redirect-stream.lisp.

Nickname

org.shirakumo.redirect-stream

Use List
  • common-lisp.
  • trivial-gray-streams.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: make-redirect-stream (&optional stream)

Creates a new REDIRECT-STREAM that directs all operations to STREAM.

See STREAM
See REDIRECT-STREAM

Package

redirect-stream.

Source

redirect-stream.lisp.


5.1.2 Generic functions

Generic Reader: stream (object)

Returns the stream the REDIRECT-STREAM redirects to.

SETF-able.

See REDIRECT-STREAM

Package

redirect-stream.

Methods
Reader Method: stream ((redirect-stream redirect-stream))

automatically generated reader method

Source

redirect-stream.lisp.

Target Slot

stream.

Generic Writer: (setf stream) (object)
Package

redirect-stream.

Methods
Writer Method: (setf stream) ((redirect-stream redirect-stream))

automatically generated writer method

Source

redirect-stream.lisp.

Target Slot

stream.


5.1.3 Standalone methods

Method: stream-advance-to-column ((stream redirect-stream) column)
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-clear-input ((stream redirect-stream))
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-clear-output ((stream redirect-stream))
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-file-position ((stream redirect-stream))
Package

trivial-gray-streams.

Source

redirect-stream.lisp.

Method: stream-finish-output ((stream redirect-stream))
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-force-output ((stream redirect-stream))
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-fresh-line ((stream redirect-stream))
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-line-column ((stream redirect-stream))
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-listen ((stream redirect-stream))
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-peek-char ((stream redirect-stream))
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-read-byte ((stream redirect-stream))
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-read-char ((stream redirect-stream))
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-read-char-no-hang ((stream redirect-stream))
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-read-line ((stream redirect-stream))
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-read-sequence ((stream redirect-stream) sequence start end &key &allow-other-keys)
Package

trivial-gray-streams.

Source

redirect-stream.lisp.

Method: stream-start-line-p ((stream redirect-stream))
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-terpri ((stream redirect-stream))
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-unread-char ((stream redirect-stream) character)
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-write-byte ((stream redirect-stream) integer)
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-write-char ((stream redirect-stream) character)
Package

sb-gray.

Source

redirect-stream.lisp.

Method: stream-write-sequence ((stream redirect-stream) sequence start end &key &allow-other-keys)
Package

trivial-gray-streams.

Source

redirect-stream.lisp.

Method: stream-write-string ((stream redirect-stream) string &optional start end)
Package

sb-gray.

Source

redirect-stream.lisp.


5.1.4 Classes

Class: redirect-stream

A gray-stream class that redirects all stream operations to its STREAM object.

If STREAM is NIL, a stream operation will do nothing and return NIL. Otherwise the exact same operation with the exact same parameters is performed on STREAM.

See STREAM

Package

redirect-stream.

Source

redirect-stream.lisp.

Direct superclasses
  • fundamental-binary-input-stream.
  • fundamental-binary-output-stream.
  • fundamental-character-input-stream.
  • fundamental-character-output-stream.
Direct methods
Direct Default Initargs
InitargValue
:streamnil
Direct slots
Slot: stream
Initargs

:stream

Readers

stream.

Writers

(setf stream).


5.2 Internals


5.2.1 Macros

Macro: define-redirect-method (name args)
Package

redirect-stream.

Source

redirect-stream.lisp.

Macro: setdocs (&body pairs)
Package

redirect-stream.

Source

documentation.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
D   F   G   M   S  
Index Entry  Section

(
(setf stream): Public generic functions
(setf stream): Public generic functions

D
define-redirect-method: Private macros

F
Function, make-redirect-stream: Public ordinary functions

G
Generic Function, (setf stream): Public generic functions
Generic Function, stream: Public generic functions

M
Macro, define-redirect-method: Private macros
Macro, setdocs: Private macros
make-redirect-stream: Public ordinary functions
Method, (setf stream): Public generic functions
Method, stream: Public generic functions
Method, stream-advance-to-column: Public standalone methods
Method, stream-clear-input: Public standalone methods
Method, stream-clear-output: Public standalone methods
Method, stream-file-position: Public standalone methods
Method, stream-finish-output: Public standalone methods
Method, stream-force-output: Public standalone methods
Method, stream-fresh-line: Public standalone methods
Method, stream-line-column: Public standalone methods
Method, stream-listen: Public standalone methods
Method, stream-peek-char: Public standalone methods
Method, stream-read-byte: Public standalone methods
Method, stream-read-char: Public standalone methods
Method, stream-read-char-no-hang: Public standalone methods
Method, stream-read-line: Public standalone methods
Method, stream-read-sequence: Public standalone methods
Method, stream-start-line-p: Public standalone methods
Method, stream-terpri: Public standalone methods
Method, stream-unread-char: Public standalone methods
Method, stream-write-byte: Public standalone methods
Method, stream-write-char: Public standalone methods
Method, stream-write-sequence: Public standalone methods
Method, stream-write-string: Public standalone methods

S
setdocs: Private macros
stream: Public generic functions
stream: Public generic functions
stream-advance-to-column: Public standalone methods
stream-clear-input: Public standalone methods
stream-clear-output: Public standalone methods
stream-file-position: Public standalone methods
stream-finish-output: Public standalone methods
stream-force-output: Public standalone methods
stream-fresh-line: Public standalone methods
stream-line-column: Public standalone methods
stream-listen: Public standalone methods
stream-peek-char: Public standalone methods
stream-read-byte: Public standalone methods
stream-read-char: Public standalone methods
stream-read-char-no-hang: Public standalone methods
stream-read-line: Public standalone methods
stream-read-sequence: Public standalone methods
stream-start-line-p: Public standalone methods
stream-terpri: Public standalone methods
stream-unread-char: Public standalone methods
stream-write-byte: Public standalone methods
stream-write-char: Public standalone methods
stream-write-sequence: Public standalone methods
stream-write-string: Public standalone methods


A.3 Variables

Index Entry  Section

S
Slot, stream: Public classes
stream: Public classes