The pipes Reference Manual

Table of Contents

The pipes Reference Manual

This is the pipes Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 18:54:38 2020 GMT+0.

1 Systems

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

1.1 pipes

Source

pipes.asd (file)

Components

• package.lisp (file)
• src.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 pipes.asd

Location

pipes.asd

Systems

pipes (system)

Packages

pipes-system

2.1.2 pipes/package.lisp

Parent

pipes (system)

Location

package.lisp

Packages

• pipes
• pipes-user

2.1.3 pipes/src.lisp

Dependency

package.lisp (file)

Parent

pipes (system)

Location

src.lisp

Exported Definitions

• +empty-pipe+ (constant)
• make-pipe (macro)
• pipe-append (function)
• pipe-elt (function)
• pipe-enumerate (function)
• pipe-filter (function)
• pipe-force (function)
• pipe-head (function)
• pipe-map (function)
• pipe-map-filtering (function)
• pipe-mappend (function)
• pipe-mappend-filtering (function)
• pipe-tail (function)
• pipe-values (function)

3 Packages

Packages are listed by definition order.

3.1 pipes-system

Source

pipes.asd

Use List

• asdf/interface
• common-lisp

3.2 pipes

Source

package.lisp (file)

Use List

common-lisp

Used By List

pipes-user

Exported Definitions

• +empty-pipe+ (constant)
• make-pipe (macro)
• pipe-append (function)
• pipe-elt (function)
• pipe-enumerate (function)
• pipe-filter (function)
• pipe-force (function)
• pipe-head (function)
• pipe-map (function)
• pipe-map-filtering (function)
• pipe-mappend (function)
• pipe-mappend-filtering (function)
• pipe-tail (function)
• pipe-values (function)

3.3 pipes-user

Source

package.lisp (file)

Use List

• pipes
• common-lisp

4 Definitions

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

4.1 Exported definitions

4.1.1 Constants

Constant: +empty-pipe+

Package

pipes

Source

src.lisp (file)

4.1.2 Macros

Macro: make-pipe HEAD TAIL

Create a pipe by evaluating head and delaying tail.

Package

pipes

Source

src.lisp (file)

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)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types