The format-out Module

Introduction

The Format-Out module is a convenient repackaging of two libraries that provides a simple way to send text to the platform’s standard output stream. For this purpose, Format-Out uses the Format module and the Standard-IO module and defines the functions format-out, force-out, format-err, and force-err. The Format-Out module exports all the identifiers described in this document.

The format Module and The standard-io Module give full details of the Format and Standard-IO libraries.

The format-out module

This section contains a reference entry for each item exported from the format-out module.

format-out Generic function

Formats its arguments on the standard output.

Signature:

format-out control-string #rest arguments => ()

Parameters:
  • control-string – An instance of <string>.
  • arguments (#rest) – Instances of <object>.
Discussion:

Calls the format function from the format module on *standard-output* from the standard-io module, control-string, and arguments.

This function is thread-safe.

See also:

format-out(<byte-string>) Sealed Method

Formats its arguments on the standard output.

Signature:

format-out control-string #rest arguments => ()

Parameters:
Discussion:

Formats its arguments on the standard output. There is one method for format-out, and it is specialized to instances of <byte-string>.

This function is thread-safe.

force-out Function

Forces pending output from *standard-output* to the operating system.

Signature:force-out () => ()
Discussion:Forces pending output from *standard-output* to the operating system using force-output.

This function is thread-safe.

format-err Generic function

Formats its arguments on the standard error.

Signature:

format-err control-string #rest arguments => ()

Parameters:
  • control-string – An instance of <string>.
  • arguments (#rest) – Instances of <object>.
Discussion:

Calls the format function from the format module on *standard-error* from the standard-io module, control-string, and arguments.

This function is thread-safe.

See also:

format-err(<byte-string>) Sealed Method

Formats its arguments on the standard error.

Signature:

format-err control-string #rest arguments => ()

Parameters:
Discussion:

Formats its arguments on the standard error. There is one method for format-err, and it is specialized to instances of <byte-string>.

This function is thread-safe.

force-err Function

Forces pending output from *standard-error* to the operating system.

Signature:force-err () => ()
Discussion:Forces pending output from *standard-error* to the operating system using force-output.

This function is thread-safe.