The pipes Reference Manual

This is the pipes Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:34:05 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 pipes

Source

pipes.asd.

Child Components

2 Files

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


2.1 Lisp


2.1.1 pipes/pipes.asd

Source

pipes.asd.

Parent Component

pipes (system).

ASDF Systems

pipes.

Packages

pipes-system.


2.1.2 pipes/package.lisp

Source

pipes.asd.

Parent Component

pipes (system).

Packages

2.1.3 pipes/src.lisp

Dependency

package.lisp (file).

Source

pipes.asd.

Parent Component

pipes (system).

Public Interface

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.

Use List

common-lisp.

Used By List

pipes-user.

Public Interface

3.3 pipes-user

Source

package.lisp.

Use List

4 Definitions

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


4.1 Public Interface


4.1.1 Constants

Constant: +empty-pipe+
Package

pipes.

Source

src.lisp.


4.1.2 Macros

Macro: make-pipe (head tail)

Create a pipe by evaluating head and delaying tail.

Package

pipes.

Source

src.lisp.


4.1.3 Ordinary functions

Function: pipe-append (x y)

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

Package

pipes.

Source

src.lisp.

Function: pipe-elt (pipe i)

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

Package

pipes.

Source

src.lisp.

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.

Function: pipe-filter (predicate pipe)

Keep only items in pipe satisfying predicate.

Package

pipes.

Source

src.lisp.

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.

Function: pipe-head (pipe)
Package

pipes.

Source

src.lisp.

Function: pipe-map (fn pipe)

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

Package

pipes.

Source

src.lisp.

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.

Function: pipe-mappend (fn pipe)

Lazily map fn over pipe, appending results.

Package

pipes.

Source

src.lisp.

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.

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.

Function: pipe-values (pipe &optional count)

Simple wrapper to return values of a pipe

Package

pipes.

Source

src.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   +  
C  
Index Entry  Section

+
+empty-pipe+: Public constants

C
Constant, +empty-pipe+: Public constants