The pipes Reference Manual

Table of Contents

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

The pipes Reference Manual

This is the pipes Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:25:13 2018 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 pipes

Source

pipes.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 pipes.asd

Location

pipes.asd

Systems

pipes (system)

Packages

pipes-system


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

2.1.2 pipes/package.lisp

Parent

pipes (system)

Location

package.lisp

Packages

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

2.1.3 pipes/src.lisp

Dependency

package.lisp (file)

Parent

pipes (system)

Location

src.lisp

Exported Definitions

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

3 Packages

Packages are listed by definition order.


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

3.1 pipes-system

Source

pipes.asd

Use List

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

3.2 pipes-user

Source

package.lisp (file)

Use List

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

3.3 pipes

Source

package.lisp (file)

Use List

common-lisp

Used By List

pipes-user

Exported Definitions

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

4 Definitions

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


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

4.1 Exported definitions


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

4.1.1 Constants

Constant: +empty-pipe+
Package

pipes

Source

src.lisp (file)


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

4.1.2 Macros

Macro: make-pipe HEAD TAIL

Create a pipe by evaluating head and delaying tail.

Package

pipes

Source

src.lisp (file)


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

4.1.3 Functions

Function: pipe-append X Y

Return a pipe that appends the elements of x and y.

Package

pipes

Source

src.lisp (file)

Function: pipe-elt PIPE I

The i-th element of pipe, 0-based.

Package

pipes

Source

src.lisp (file)

Function: pipe-enumerate PIPE &key COUNT KEY RESULT

Go through all (or count) elements of pipe, possibly applying the KEY function. (Try PRINT.)

Package

pipes

Source

src.lisp (file)

Function: pipe-filter PREDICATE PIPE

Keep only items in pipe satisfying predicate.

Package

pipes

Source

src.lisp (file)

Function: pipe-force PIPE

Force the enumeration of all of the pipe. Never returns if the pipe is infinite in length.

Package

pipes

Source

src.lisp (file)

Function: pipe-head PIPE
Package

pipes

Source

src.lisp (file)

Function: pipe-map FN PIPE

Map fn over pipe, delaying all but the first fn call.

Package

pipes

Source

src.lisp (file)

Function: pipe-map-filtering FN PIPE &optional FILTER-PRED

Map fn over pipe, delaying all but the first fn call, while filtering results.

Package

pipes

Source

src.lisp (file)

Function: pipe-mappend FN PIPE

Lazily map fn over pipe, appending results.

Package

pipes

Source

src.lisp (file)

Function: pipe-mappend-filtering FN PIPE &optional FILTER-PRED

Map fn over pipe, delaying all but the first fn call, appending results while filtering.

Package

pipes

Source

src.lisp (file)

Function: pipe-tail PIPE

Return tail of pipe or list, and destructively update the tail if it is a function.

Package

pipes

Source

src.lisp (file)

Function: pipe-values PIPE &optional COUNT

Simple wrapper to return values of a pipe

Package

pipes

Source

src.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   P  
Index Entry  Section

F
File, Lisp, pipes.asd: The pipes<dot>asd file
File, Lisp, pipes/package.lisp: The pipes/package<dot>lisp file
File, Lisp, pipes/src.lisp: The pipes/src<dot>lisp file

L
Lisp File, pipes.asd: The pipes<dot>asd file
Lisp File, pipes/package.lisp: The pipes/package<dot>lisp file
Lisp File, pipes/src.lisp: The pipes/src<dot>lisp file

P
pipes.asd: The pipes<dot>asd file
pipes/package.lisp: The pipes/package<dot>lisp file
pipes/src.lisp: The pipes/src<dot>lisp file

Jump to:   F   L   P  

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

A.2 Functions

Jump to:   F   M   P  
Index Entry  Section

F
Function, pipe-append: Exported functions
Function, pipe-elt: Exported functions
Function, pipe-enumerate: Exported functions
Function, pipe-filter: Exported functions
Function, pipe-force: Exported functions
Function, pipe-head: Exported functions
Function, pipe-map: Exported functions
Function, pipe-map-filtering: Exported functions
Function, pipe-mappend: Exported functions
Function, pipe-mappend-filtering: Exported functions
Function, pipe-tail: Exported functions
Function, pipe-values: Exported functions

M
Macro, make-pipe: Exported macros
make-pipe: Exported macros

P
pipe-append: Exported functions
pipe-elt: Exported functions
pipe-enumerate: Exported functions
pipe-filter: Exported functions
pipe-force: Exported functions
pipe-head: Exported functions
pipe-map: Exported functions
pipe-map-filtering: Exported functions
pipe-mappend: Exported functions
pipe-mappend-filtering: Exported functions
pipe-tail: Exported functions
pipe-values: Exported functions

Jump to:   F   M   P  

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

A.3 Variables

Jump to:   +  
C  
Index Entry  Section

+
+empty-pipe+: Exported constants

C
Constant, +empty-pipe+: Exported constants

Jump to:   +  
C  

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

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, pipes: The pipes package
Package, pipes-system: The pipes-system package
Package, pipes-user: The pipes-user package
pipes: The pipes system
pipes: The pipes package
pipes-system: The pipes-system package
pipes-user: The pipes-user package

S
System, pipes: The pipes system

Jump to:   P   S