This is the bencode Reference Manual, version 3.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:41:19 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
bencodeBencode
Johan Andersson <nilsjohanandersson@gmail.com>
MIT
3.0.1
flexi-streams (system).
package.lisp (file).
dictionary.lisp (file).
encode.lisp (file).
decode.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
bencode/bencode.asdbencode/package.lispbencode/dictionary.lispbencode/encode.lispbencode/decode.lispbencode/dictionary.lisppackage.lisp (file).
bencode (system).
*binary-key-p* (special variable).
binary-dictionary-key-p (function).
dictionary->alist (function).
get-dictionary (function).
key (reader method).
make-dictionary (function).
nonstring-dictionary-key (condition).
bencode/encode.lisppackage.lisp (file).
dictionary.lisp (file).
bencode (system).
encode (generic function).
*ascii* (special variable).
render-integer (function).
string-header (function).
bencode/decode.lisppackage.lisp (file).
dictionary.lisp (file).
bencode (system).
decode (generic function).
*dictionary-keys* (special variable).
actual-octet (reader method).
decode-binary-string (function).
decode-dictionary (function).
decode-integer (function).
decode-list (function).
decode-string (function).
expected-octet (reader method).
invalid-value-type (condition).
maybe-read-char (function).
must-read-char (function).
must-read-octets (function).
octet (reader method).
read-external-format (function).
read-integers (function).
restart-case-loop (macro).
unexpected-octet (condition).
Packages are listed by definition order.
bencodecommon-lisp.
*binary-key-p* (special variable).
decode (generic function).
encode (generic function).
*ascii* (special variable).
*dictionary-keys* (special variable).
actual-octet (generic reader).
binary-dictionary-key-p (function).
decode-binary-string (function).
decode-dictionary (function).
decode-integer (function).
decode-list (function).
decode-string (function).
dictionary->alist (function).
expected-octet (generic reader).
get-dictionary (function).
invalid-value-type (condition).
key (generic reader).
make-dictionary (function).
maybe-read-char (function).
must-read-char (function).
must-read-octets (function).
nonstring-dictionary-key (condition).
octet (generic reader).
read-external-format (function).
read-integers (function).
render-integer (function).
restart-case-loop (macro).
string-header (function).
unexpected-octet (condition).
Definitions are sorted by export status, category, package, and then by lexicographic order.
When decoding dictionary values, this function is passed a list,
where the first element is the key of the value. If the dictionary was
in turn a dictionary value, that key is the second element of the
list, and so on. Should a dictionary be a value in a bencoded list,
the corresponding element in the list will be the symbol :list. When
the function return a true value, the dictionary value will be
binary. Otherwise it will be decoded as a string.
The default function in *binary-key-p* returns true for the "pieces" value in the "info" dictionary. All other values are decoded as strings.
Decode a bencode object from a stream or sequence.
If input is a flexi-stream, its external-format will be used when
decoding strings. If input is a string, all characters must have
char-codes that fit in an (unsigned-byte 8). Otherwise, the value of
the external-format parameter is used to create a flexi-stream for
decoding. The default is UTF-8.
Encode object and write it to stream or, if stream
is nil, use an in-memory stream and return the resulting sequence.
The external-format is used when encoding strings. UTF-8 is the
default.
array) (stream flexi-stream) &key &allow-other-keys) ¶integer) (stream flexi-stream) &key &allow-other-keys) ¶string) (stream flexi-stream) &key &allow-other-keys) ¶hash-table) (stream flexi-stream) &key &allow-other-keys) ¶list) (stream flexi-stream) &key &allow-other-keys) ¶(eql nil)) &key external-format) ¶stream) &key external-format) ¶Returns an alist representation of the dictionary.
Makes a dictionary from a plist or alist. Keys must be strings.
unexpected-octet)) ¶unexpected-octet)) ¶nonstring-dictionary-key)) ¶key.
invalid-value-type)) ¶error.
error.
key.
| Jump to: | A B D E F G K M O R S |
|---|
| Jump to: | A B D E F G K M O R S |
|---|
| Jump to: | *
A E K O S |
|---|
| Jump to: | *
A E K O S |
|---|
| Jump to: | B C D E F I N P S U |
|---|
| Jump to: | B C D E F I N P S U |
|---|