The trivial-yenc Reference Manual

This is the trivial-yenc Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:12:29 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-yenc

Decode yenc file to a binary file

Author

Stacksmith <>

License

MIT

Dependency

split-sequence (system).

Source

trivial-yenc.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 trivial-yenc/trivial-yenc.asd

Source

trivial-yenc.asd.

Parent Component

trivial-yenc (system).

ASDF Systems

trivial-yenc.


3.1.2 trivial-yenc/package.lisp

Source

trivial-yenc.asd.

Parent Component

trivial-yenc (system).

Packages

trivial-yenc.


3.1.3 trivial-yenc/trivial-yenc.lisp

Dependency

package.lisp (file).

Source

trivial-yenc.asd.

Parent Component

trivial-yenc (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 trivial-yenc

Source

package.lisp.

Use List
  • common-lisp.
  • split-sequence.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: decode-part (in path)

decode stream in and write file in path directory. Return part number or nil

Package

trivial-yenc.

Source

trivial-yenc.lisp.

Function: test1 ()

decode two-roads.yenc into two-roads.out; load the output file and print to screen.

Package

trivial-yenc.

Source

trivial-yenc.lisp.

Function: test2 ()

decode a multi-part binary from two files.

Package

trivial-yenc.

Source

trivial-yenc.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: =yend
Package

trivial-yenc.

Source

trivial-yenc.lisp.


5.2.2 Ordinary functions

Function: bytes-to-string (line)

convert vector of bytes to a string

Package

trivial-yenc.

Source

trivial-yenc.lisp.

Function: bytes-to-vec (line)

convert vector of bytes to a string

Package

trivial-yenc.

Source

trivial-yenc.lisp.

Function: decode-data (vec out)

decode bytes in vec into out stream

Package

trivial-yenc.

Source

trivial-yenc.lisp.

Function: decode-line (in out)

decode a line of encoded data from in and output to out

Package

trivial-yenc.

Source

trivial-yenc.lisp.

Function: decode-lines (in out)
Package

trivial-yenc.

Source

trivial-yenc.lisp.

Function: header-prim (str start end)

parse a simple header consisting of pure name=value pairs

Package

trivial-yenc.

Source

trivial-yenc.lisp.

Function: header-ybegin (in)
Package

trivial-yenc.

Source

trivial-yenc.lisp.

Function: header-ybegin- (str)

read a parameter line starting with =ybegin; return an alist.

Package

trivial-yenc.

Source

trivial-yenc.lisp.

Function: header-ypart (in)
Package

trivial-yenc.

Source

trivial-yenc.lisp.

Function: header-ypart- (str)
Package

trivial-yenc.

Source

trivial-yenc.lisp.

Function: param-to-pair (param)

convert string x=y to (x . y), converting y to a number if possible

Package

trivial-yenc.

Source

trivial-yenc.lisp.

Function: read-bytes (in)
Package

trivial-yenc.

Source

trivial-yenc.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   B   D   F   H   P   R   T  
Index Entry  Section

B
bytes-to-string: Private ordinary functions
bytes-to-vec: Private ordinary functions

D
decode-data: Private ordinary functions
decode-line: Private ordinary functions
decode-lines: Private ordinary functions
decode-part: Public ordinary functions

F
Function, bytes-to-string: Private ordinary functions
Function, bytes-to-vec: Private ordinary functions
Function, decode-data: Private ordinary functions
Function, decode-line: Private ordinary functions
Function, decode-lines: Private ordinary functions
Function, decode-part: Public ordinary functions
Function, header-prim: Private ordinary functions
Function, header-ybegin: Private ordinary functions
Function, header-ybegin-: Private ordinary functions
Function, header-ypart: Private ordinary functions
Function, header-ypart-: Private ordinary functions
Function, param-to-pair: Private ordinary functions
Function, read-bytes: Private ordinary functions
Function, test1: Public ordinary functions
Function, test2: Public ordinary functions

H
header-prim: Private ordinary functions
header-ybegin: Private ordinary functions
header-ybegin-: Private ordinary functions
header-ypart: Private ordinary functions
header-ypart-: Private ordinary functions

P
param-to-pair: Private ordinary functions

R
read-bytes: Private ordinary functions

T
test1: Public ordinary functions
test2: Public ordinary functions


A.3 Variables

Jump to:   =  
S  
Index Entry  Section

=
=yend: Private special variables

S
Special Variable, =yend: Private special variables