.. index:: single: format
.. _format/0:

.. rst-class:: right

**object**

``format``
==========

Formatted output predicates.

| **Availability:** 
|    ``logtalk_load(format(loader))``

| **Author:** Paulo Moura
| **Version:** 1:3:0
| **Date:** 2025-11-18

| **Compilation flags:**
|    ``static, context_switching_calls``


| **Dependencies:**
|   (none)


| **Remarks:**
|    (none)

| **Inherited public predicates:**
|    (none)

.. contents::
   :local:
   :backlinks: top

Public predicates
-----------------

.. index:: format/3
.. _format/0::format/3:

``format/3``
^^^^^^^^^^^^

Writes a list of arguments after a format specification to the specified output stream.

| **Compilation flags:**
|    ``static``

| **Template:**
|    ``format(Stream,Format,Arguments)``
| **Mode and number of proofs:**
|    ``format(@stream_or_alias,+atom,@list)`` - ``zero_or_one``
|    ``format(@stream_or_alias,+list(character_code),@list)`` - ``zero_or_one``
|    ``format(@stream_or_alias,+list(character),@list)`` - ``zero_or_one``


------------

.. index:: format/2
.. _format/0::format/2:

``format/2``
^^^^^^^^^^^^

Writes a list of arguments after a format specification to the current output stream.

| **Compilation flags:**
|    ``static``

| **Template:**
|    ``format(Format,Arguments)``
| **Mode and number of proofs:**
|    ``format(+atom,@list)`` - ``zero_or_one``
|    ``format(+list(character_code),@list)`` - ``zero_or_one``
|    ``format(+list(character),@list)`` - ``zero_or_one``


------------

Protected predicates
--------------------

(none)

Private predicates
------------------

(none)

Operators
---------

(none)

