The swap-bytes Reference Manual

Table of Contents

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

The swap-bytes Reference Manual

This is the swap-bytes Reference Manual, version 1.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:38:07 2018 GMT+0.


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

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.


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

2 Systems

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


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

2.1 swap-bytes

Maintainer

Stelian Ionescu <sionescu@cddr.org>

Author

Stas Boukarev <stassats@gmail.com>

License

MIT

Description

Optimized byte-swapping primitives.

Version

1.1

Defsystem Dependency

trivial-features

Dependency

trivial-features

Source

swap-bytes.asd (file)

Components

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

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 files   [Contents][Index]

3.1.1 swap-bytes.asd

Location

swap-bytes.asd

Systems

swap-bytes (system)


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

3.1.2 swap-bytes/package.lisp

Parent

swap-bytes (system)

Location

package.lisp

Packages

swap-bytes


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

3.1.3 swap-bytes/ccl.lisp

If Feature

(and ccl (or x86 x86-64))

Dependency

package.lisp (file)

Parent

swap-bytes (system)

Location

ccl.lisp


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

3.1.4 swap-bytes/sbcl-defknowns.lisp

If Feature

(and sbcl (or x86 x86-64))

Dependency

package.lisp (file)

Parent

swap-bytes (system)

Location

sbcl-defknowns.lisp


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

3.1.5 swap-bytes/sbcl-vops.lisp

If Feature

(and sbcl (or x86 x86-64))

Dependencies
Parent

swap-bytes (system)

Location

sbcl-vops.lisp


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

3.1.6 swap-bytes/sbcl.lisp

If Feature

(and sbcl (or x86 x86-64))

Dependencies
Parent

swap-bytes (system)

Location

sbcl.lisp

Exported Definitions

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

3.1.7 swap-bytes/portable.lisp

If Feature

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

Dependencies
Parent

swap-bytes (system)

Location

portable.lisp


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

3.1.8 swap-bytes/network.lisp

Dependencies
Parent

swap-bytes (system)

Location

network.lisp

Exported Definitions

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

3.1.9 swap-bytes/endianness.lisp

Dependencies
Parent

swap-bytes (system)

Location

endianness.lisp

Exported Definitions
Internal Definitions

endianness-designator (type)


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

4 Packages

Packages are listed by definition order.


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

4.1 swap-bytes

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

endianness-designator (type)


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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Constants

Constant: +endianness+
Package

swap-bytes

Source

endianness.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: endianness ENDIANNESS
Package

swap-bytes

Source

endianness.lisp (file)

Function: find-swap-byte-function &key SIZE FROM TO
Package

swap-bytes

Source

endianness.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: swap-bytes-16 INTEGER
Package

swap-bytes

Source

sbcl.lisp (file)

Function: swap-bytes-32 INTEGER
Package

swap-bytes

Source

sbcl.lisp (file)

Function: swap-bytes-64 INTEGER
Package

swap-bytes

Source

sbcl.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Types

Type: endianness ()
Package

swap-bytes

Source

endianness.lisp (file)


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

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Types

Type: endianness-designator ()
Package

swap-bytes

Source

endianness.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   S  
Index Entry  Section

F
File, Lisp, swap-bytes.asd: The swap-bytes<dot>asd file
File, Lisp, swap-bytes/ccl.lisp: The swap-bytes/ccl<dot>lisp file
File, Lisp, swap-bytes/endianness.lisp: The swap-bytes/endianness<dot>lisp file
File, Lisp, swap-bytes/network.lisp: The swap-bytes/network<dot>lisp file
File, Lisp, swap-bytes/package.lisp: The swap-bytes/package<dot>lisp file
File, Lisp, swap-bytes/portable.lisp: The swap-bytes/portable<dot>lisp file
File, Lisp, swap-bytes/sbcl-defknowns.lisp: The swap-bytes/sbcl-defknowns<dot>lisp file
File, Lisp, swap-bytes/sbcl-vops.lisp: The swap-bytes/sbcl-vops<dot>lisp file
File, Lisp, swap-bytes/sbcl.lisp: The swap-bytes/sbcl<dot>lisp file

L
Lisp File, swap-bytes.asd: The swap-bytes<dot>asd file
Lisp File, swap-bytes/ccl.lisp: The swap-bytes/ccl<dot>lisp file
Lisp File, swap-bytes/endianness.lisp: The swap-bytes/endianness<dot>lisp file
Lisp File, swap-bytes/network.lisp: The swap-bytes/network<dot>lisp file
Lisp File, swap-bytes/package.lisp: The swap-bytes/package<dot>lisp file
Lisp File, swap-bytes/portable.lisp: The swap-bytes/portable<dot>lisp file
Lisp File, swap-bytes/sbcl-defknowns.lisp: The swap-bytes/sbcl-defknowns<dot>lisp file
Lisp File, swap-bytes/sbcl-vops.lisp: The swap-bytes/sbcl-vops<dot>lisp file
Lisp File, swap-bytes/sbcl.lisp: The swap-bytes/sbcl<dot>lisp file

S
swap-bytes.asd: The swap-bytes<dot>asd file
swap-bytes/ccl.lisp: The swap-bytes/ccl<dot>lisp file
swap-bytes/endianness.lisp: The swap-bytes/endianness<dot>lisp file
swap-bytes/network.lisp: The swap-bytes/network<dot>lisp file
swap-bytes/package.lisp: The swap-bytes/package<dot>lisp file
swap-bytes/portable.lisp: The swap-bytes/portable<dot>lisp file
swap-bytes/sbcl-defknowns.lisp: The swap-bytes/sbcl-defknowns<dot>lisp file
swap-bytes/sbcl-vops.lisp: The swap-bytes/sbcl-vops<dot>lisp file
swap-bytes/sbcl.lisp: The swap-bytes/sbcl<dot>lisp file

Jump to:   F   L   S  

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

A.2 Functions

Jump to:   E   F   H   N   S  
Index Entry  Section

E
endianness: Exported functions

F
find-swap-byte-function: Exported functions
Function, endianness: Exported functions
Function, find-swap-byte-function: Exported functions
Function, htonl: Exported functions
Function, htonq: Exported functions
Function, htons: Exported functions
Function, ntohl: Exported functions
Function, ntohq: Exported functions
Function, ntohs: Exported functions
Function, swap-bytes-16: Exported functions
Function, swap-bytes-32: Exported functions
Function, swap-bytes-64: Exported functions

H
htonl: Exported functions
htonq: Exported functions
htons: Exported functions

N
ntohl: Exported functions
ntohq: Exported functions
ntohs: Exported functions

S
swap-bytes-16: Exported functions
swap-bytes-32: Exported functions
swap-bytes-64: Exported functions

Jump to:   E   F   H   N   S  

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

A.3 Variables

Jump to:   +  
C  
Index Entry  Section

+
+endianness+: Exported constants

C
Constant, +endianness+: Exported constants

Jump to:   +  
C  

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

A.4 Data types

Jump to:   E   P   S   T  
Index Entry  Section

E
endianness: Exported types
endianness-designator: Internal types

P
Package, swap-bytes: The swap-bytes package

S
swap-bytes: The swap-bytes system
swap-bytes: The swap-bytes package
System, swap-bytes: The swap-bytes system

T
Type, endianness: Exported types
Type, endianness-designator: Internal types

Jump to:   E   P   S   T