The cl-bus Reference Manual

Table of Contents

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

The cl-bus Reference Manual

This is the cl-bus Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 03:37:32 2022 GMT+0.


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

1 Systems

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


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

1.1 cl-bus

Author

Thomas Bartscher <thomas-bartscher@weltraumschlangen.de>

License

BSD-3

Description

A(n almost) referentially transparent interface for streams

Version

0.0.1

Source

cl-bus.asd (file)

Components

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

2 Files

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


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

2.1 Lisp


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

2.1.1 cl-bus.asd

Location

cl-bus.asd

Systems

cl-bus (system)


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

2.1.2 cl-bus/package.lisp

Parent

cl-bus (system)

Location

package.lisp

Packages

cl-bus


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

2.1.3 cl-bus/cl-bus.lisp

Dependency

package.lisp (file)

Parent

cl-bus (system)

Location

cl-bus.lisp

Exported Definitions
Internal Definitions

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

3 Packages

Packages are listed by definition order.


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

3.1 cl-bus

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

4 Definitions

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


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

4.1 Exported definitions


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

4.1.1 Macros

Macro: with-bus VAR STREAM &body BODY
Package

cl-bus

Source

cl-bus.lisp (file)

Macro: with-file-bus (VAR FILESPEC &rest OPTIONS) &body BODY
Package

cl-bus

Source

cl-bus.lisp (file)


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

4.1.2 Functions

Function: buffer<- BUS

Returns the buffer of the bus.

Package

cl-bus

Source

cl-bus.lisp (file)

Function: bus-advance BUS &optional LENGTH

Returns two values. The second value is NIL if advancing failed and T otherwise. The first value is a bus that starts reading LENGTH characters into BUS if advancing succeeded or an empty bus if advancing failed.
Advancing fails when LENGTH is greater than the length of the buffer of BUS.

Package

cl-bus

Source

cl-bus.lisp (file)

Function: bus-consume BUS &optional LENGTH

Returns three values: First a string as in BUS-READ, second a bus as in BUS-ADVANCE, third T if reading succeeded as in BUS-READ, NIL otherwise.

Package

cl-bus

Source

cl-bus.lisp (file)

Function: bus-read BUS &optional LENGTH

Returns two values. The second value is NIL if reading failed and T otherwise. The first value is a string of length LENGTH when reading succeeded, or a shorter string if reading failed. Reading fails when EOF is reached while reading from the underlying stream of BUS or when BUS does not have an underlying stream.

Package

cl-bus

Source

cl-bus.lisp (file)


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

4.1.3 Generic functions

Generic Function: bus<- OBJ

Takes a string, bus, or stream and returns a bus that reads across that string or stream

Package

cl-bus

Source

cl-bus.lisp (file)

Methods
Method: bus<- (OBJ bus)
Method: bus<- (OBJ stream)
Method: bus<- (OBJ string)

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

4.1.4 Structures

Structure: bus ()
Package

cl-bus

Source

cl-bus.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

bus<- (method)

Direct slots
Slot: buffer
Type

string

Initform

""

Readers

bus-buffer (function)

Writers

(setf bus-buffer) (function)

Slot: stream
Type

(or stream null)

Readers

bus-stream (function)

Writers

(setf bus-stream) (function)

Slot: child
Type

(or cl-bus:bus null)

Readers

bus-child (function)

Writers

(setf bus-child) (function)


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

4.2 Internal definitions


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

4.2.1 Functions

Function: bus-buffer INSTANCE
Function: (setf bus-buffer) VALUE INSTANCE
Package

cl-bus

Source

cl-bus.lisp (file)

Function: bus-child INSTANCE
Function: (setf bus-child) VALUE INSTANCE
Package

cl-bus

Source

cl-bus.lisp (file)

Function: bus-p OBJECT
Package

cl-bus

Source

cl-bus.lisp (file)

Function: bus-stream INSTANCE
Function: (setf bus-stream) VALUE INSTANCE
Package

cl-bus

Source

cl-bus.lisp (file)

Function: copy-bus INSTANCE
Package

cl-bus

Source

cl-bus.lisp (file)

Function: make-bus &key (BUFFER BUFFER) (STREAM STREAM) (CHILD CHILD)
Package

cl-bus

Source

cl-bus.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-bus.asd: The cl-bus․asd file
cl-bus/cl-bus.lisp: The cl-bus/cl-bus․lisp file
cl-bus/package.lisp: The cl-bus/package․lisp file

F
File, Lisp, cl-bus.asd: The cl-bus․asd file
File, Lisp, cl-bus/cl-bus.lisp: The cl-bus/cl-bus․lisp file
File, Lisp, cl-bus/package.lisp: The cl-bus/package․lisp file

L
Lisp File, cl-bus.asd: The cl-bus․asd file
Lisp File, cl-bus/cl-bus.lisp: The cl-bus/cl-bus․lisp file
Lisp File, cl-bus/package.lisp: The cl-bus/package․lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   (  
B   C   F   G   M   W  
Index Entry  Section

(
(setf bus-buffer): Internal functions
(setf bus-child): Internal functions
(setf bus-stream): Internal functions

B
buffer<-: Exported functions
bus-advance: Exported functions
bus-buffer: Internal functions
bus-child: Internal functions
bus-consume: Exported functions
bus-p: Internal functions
bus-read: Exported functions
bus-stream: Internal functions
bus<-: Exported generic functions
bus<-: Exported generic functions
bus<-: Exported generic functions
bus<-: Exported generic functions

C
copy-bus: Internal functions

F
Function, (setf bus-buffer): Internal functions
Function, (setf bus-child): Internal functions
Function, (setf bus-stream): Internal functions
Function, buffer<-: Exported functions
Function, bus-advance: Exported functions
Function, bus-buffer: Internal functions
Function, bus-child: Internal functions
Function, bus-consume: Exported functions
Function, bus-p: Internal functions
Function, bus-read: Exported functions
Function, bus-stream: Internal functions
Function, copy-bus: Internal functions
Function, make-bus: Internal functions

G
Generic Function, bus<-: Exported generic functions

M
Macro, with-bus: Exported macros
Macro, with-file-bus: Exported macros
make-bus: Internal functions
Method, bus<-: Exported generic functions
Method, bus<-: Exported generic functions
Method, bus<-: Exported generic functions

W
with-bus: Exported macros
with-file-bus: Exported macros

Jump to:   (  
B   C   F   G   M   W  

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

A.3 Variables

Jump to:   B   C   S  
Index Entry  Section

B
buffer: Exported structures

C
child: Exported structures

S
Slot, buffer: Exported structures
Slot, child: Exported structures
Slot, stream: Exported structures
stream: Exported structures

Jump to:   B   C   S  

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

A.4 Data types

Jump to:   B   C   P   S  
Index Entry  Section

B
bus: Exported structures

C
cl-bus: The cl-bus system
cl-bus: The cl-bus package

P
Package, cl-bus: The cl-bus package

S
Structure, bus: Exported structures
System, cl-bus: The cl-bus system

Jump to:   B   C   P   S