The cl-bus Reference Manual

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 4.0 beta 2 "William Riker" on Thu Sep 15 03:36:08 2022 GMT+0.

Table of Contents


1 Systems

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


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

1.1 cl-bus

A(n almost) referentially transparent interface for streams

Author

Thomas Bartscher <thomas-bartscher@weltraumschlangen.de>

License

BSD-3

Version

0.0.1

Source

cl-bus.asd.

Child Components

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   [Contents][Index]

2.1.1 cl-bus/cl-bus.asd

Source

cl-bus.asd.

Parent Component

cl-bus (system).

ASDF Systems

cl-bus.


2.1.2 cl-bus/package.lisp

Source

cl-bus.asd.

Parent Component

cl-bus (system).

Packages

cl-bus.


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

2.1.3 cl-bus/cl-bus.lisp

Dependency

package.lisp (file).

Source

cl-bus.asd.

Parent Component

cl-bus (system).

Public Interface
Internals

3 Packages

Packages are listed by definition order.


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

3.1 cl-bus

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

4 Definitions

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


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

4.1 Public Interface


4.1.1 Macros

Macro: with-bus (var stream &body body)
Package

cl-bus.

Source

cl-bus.lisp.

Macro: with-file-bus ((var filespec &rest options) &body body)
Package

cl-bus.

Source

cl-bus.lisp.


4.1.2 Ordinary functions

Function: buffer<- (bus)

Returns the buffer of the bus.

Package

cl-bus.

Source

cl-bus.lisp.

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.

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.

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.


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.

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

4.1.4 Structures

Structure: bus
Package

cl-bus.

Source

cl-bus.lisp.

Direct superclasses

structure-object.

Direct methods

bus<-.

Direct slots
Slot: buffer
Type

string

Initform

""

Readers

bus-buffer.

Writers

(setf bus-buffer).

Slot: stream
Package

common-lisp.

Type

(or stream null)

Readers

bus-stream.

Writers

(setf bus-stream).

Slot: child
Type

(or cl-bus:bus null)

Readers

bus-child.

Writers

(setf bus-child).


4.2 Internals


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

4.2.1 Ordinary functions

Reader: bus-buffer (instance)
Writer: (setf bus-buffer) (instance)
Package

cl-bus.

Source

cl-bus.lisp.

Target Slot

buffer.

Reader: bus-child (instance)
Writer: (setf bus-child) (instance)
Package

cl-bus.

Source

cl-bus.lisp.

Target Slot

child.

Function: bus-p (object)
Package

cl-bus.

Source

cl-bus.lisp.

Reader: bus-stream (instance)
Writer: (setf bus-stream) (instance)
Package

cl-bus.

Source

cl-bus.lisp.

Target Slot

stream.

Function: copy-bus (instance)
Package

cl-bus.

Source

cl-bus.lisp.

Function: make-bus (&key buffer stream child)
Package

cl-bus.

Source

cl-bus.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

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

(
(setf bus-buffer): Private ordinary functions
(setf bus-child): Private ordinary functions
(setf bus-stream): Private ordinary functions

B
buffer<-: Public ordinary functions
bus-advance: Public ordinary functions
bus-buffer: Private ordinary functions
bus-child: Private ordinary functions
bus-consume: Public ordinary functions
bus-p: Private ordinary functions
bus-read: Public ordinary functions
bus-stream: Private ordinary functions
bus<-: Public generic functions
bus<-: Public generic functions
bus<-: Public generic functions
bus<-: Public generic functions

C
copy-bus: Private ordinary functions

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

G
Generic Function, bus<-: Public generic functions

M
Macro, with-bus: Public macros
Macro, with-file-bus: Public macros
make-bus: Private ordinary functions
Method, bus<-: Public generic functions
Method, bus<-: Public generic functions
Method, bus<-: Public generic functions

W
with-bus: Public macros
with-file-bus: Public 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: Public structures

C
child: Public structures

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

Jump to:   B   C   S