The swap-bytes Reference Manual

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

The swap-bytes Reference Manual

This is the swap-bytes Reference Manual, version 1.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 07:18:13 2022 GMT+0.

Table of Contents


1 Introduction

SWAP-BYTES

A library for changing endianness of unsigned integers of length 1/2/4/8. Very useful in implementing various network protocols and file formats.


2 Systems

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


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

2.1 swap-bytes

Optimized byte-swapping primitives.

Maintainer

Stelian Ionescu <sionescu@cddr.org>

Author

Stas Boukarev <stassats@gmail.com>

License

MIT

Version

1.2

Defsystem Dependency

trivial-features (system).

Dependency

trivial-features (system).

Source

swap-bytes.asd.

Child Components

3 Files

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


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

3.1 Lisp


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

3.1.1 swap-bytes/swap-bytes.asd

Source

swap-bytes.asd.

Parent Component

swap-bytes (system).

ASDF Systems

swap-bytes.


3.1.2 swap-bytes/package.lisp

Source

swap-bytes.asd.

Parent Component

swap-bytes (system).

Packages

swap-bytes.


3.1.3 swap-bytes/ccl.lisp

If Feature

(:and :ccl (:or :x86 :x86-64))

Dependency

package.lisp (file).

Source

swap-bytes.asd.

Parent Component

swap-bytes (system).


3.1.4 swap-bytes/sbcl-defknowns.lisp

If Feature

(:and :sbcl (:or :x86 :x86-64))

Dependency

package.lisp (file).

Source

swap-bytes.asd.

Parent Component

swap-bytes (system).


3.1.5 swap-bytes/sbcl-vops.lisp

If Feature

(:and :sbcl (:or :x86 :x86-64))

Dependencies
Source

swap-bytes.asd.

Parent Component

swap-bytes (system).


3.1.6 swap-bytes/sbcl.lisp

If Feature

(:and :sbcl (:or :x86 :x86-64))

Dependencies
Source

swap-bytes.asd.

Parent Component

swap-bytes (system).

Public Interface

3.1.7 swap-bytes/portable.lisp

If Feature

(:not (:or (:and :ccl (:or :x86 :x86-64)) (:and :sbcl (:or :x86 :x86-64))))

Dependencies
Source

swap-bytes.asd.

Parent Component

swap-bytes (system).


3.1.8 swap-bytes/network.lisp

Dependencies
Source

swap-bytes.asd.

Parent Component

swap-bytes (system).

Public Interface

3.1.9 swap-bytes/endianness.lisp

Dependencies
Source

swap-bytes.asd.

Parent Component

swap-bytes (system).

Public Interface
Internals

endianness-designator (type).


4 Packages

Packages are listed by definition order.


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

4.1 swap-bytes

Source

package.lisp.

Use List
  • common-lisp.
  • sb-assem.
  • sb-c.
Public Interface
Internals

endianness-designator (type).


5 Definitions

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


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

5.1 Public Interface


5.1.1 Constants

Constant: +endianness+
Package

swap-bytes.

Source

endianness.lisp.


Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.2 Ordinary functions

Function: endianness (endianness)
Package

swap-bytes.

Source

endianness.lisp.

Function: find-swap-byte-function (&key size from to)
Package

swap-bytes.

Source

endianness.lisp.

Function: htonl ()

Convert (unsigned-byte 32) from host order(little- or big-endian) to network order(always big-endian).

Package

swap-bytes.

Source

network.lisp.

Function: htonq ()

Convert (unsigned-byte 64) from host order(little- or big-endian) to network order(always big-endian).

Package

swap-bytes.

Source

network.lisp.

Function: htons ()

Convert (unsigned-byte 16) from host order(little- or big-endian) to network order(always big-endian).

Package

swap-bytes.

Source

network.lisp.

Function: ntohl ()

Convert (unsigned-byte 32) from network order(always big-endian) to host order(little- or big-endian).

Package

swap-bytes.

Source

network.lisp.

Function: ntohq ()

Convert (unsigned-byte 64) from network order(always big-endian) to host order(little- or big-endian).

Package

swap-bytes.

Source

network.lisp.

Function: ntohs ()

Convert (unsigned-byte 16) from network order(always big-endian) to host order(little- or big-endian).

Package

swap-bytes.

Source

network.lisp.

Function: swap-bytes-16 (integer)
Package

swap-bytes.

Source

sbcl.lisp.

Function: swap-bytes-32 (integer)
Package

swap-bytes.

Source

sbcl.lisp.

Function: swap-bytes-64 (integer)
Package

swap-bytes.

Source

sbcl.lisp.


5.1.3 Types

Type: endianness ()
Package

swap-bytes.

Source

endianness.lisp.


5.2 Internals


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

5.2.1 Types

Type: endianness-designator ()
Package

swap-bytes.

Source

endianness.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.3 Variables

Jump to:   +  
C  
Index Entry  Section

+
+endianness+: Public constants

C
Constant, +endianness+: Public constants

Jump to:   +  
C