1
0
Fork 0
cl-sites/guile.html_node/rnrs-records-inspection.html

132 lines
8 KiB
HTML
Raw Normal View History

2024-12-17 12:49:28 +01:00
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual documents Guile version 3.0.10.
Copyright (C) 1996-1997, 2000-2005, 2009-2023 Free Software Foundation,
Inc.
Copyright (C) 2021 Maxime Devos
Copyright (C) 2024 Tomas Volf
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the section entitled "GNU Free
Documentation License." -->
<title>rnrs records inspection (Guile Reference Manual)</title>
<meta name="description" content="rnrs records inspection (Guile Reference Manual)">
<meta name="keywords" content="rnrs records inspection (Guile Reference Manual)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content=".texi2any-real">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="R6RS-Standard-Libraries.html" rel="up" title="R6RS Standard Libraries">
<link href="rnrs-exceptions.html" rel="next" title="rnrs exceptions">
<link href="rnrs-records-procedural.html" rel="prev" title="rnrs records procedural">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="https://www.gnu.org/software/gnulib/manual.css">
</head>
<body lang="en">
<div class="subsubsection-level-extent" id="rnrs-records-inspection">
<div class="nav-panel">
<p>
Next: <a href="rnrs-exceptions.html" accesskey="n" rel="next">rnrs exceptions</a>, Previous: <a href="rnrs-records-procedural.html" accesskey="p" rel="prev">rnrs records procedural</a>, Up: <a href="R6RS-Standard-Libraries.html" accesskey="u" rel="up">R6RS Standard Libraries</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsubsection" id="rnrs-records-inspection-1"><span>7.6.2.11 rnrs records inspection<a class="copiable-link" href="#rnrs-records-inspection-1"> &para;</a></span></h4>
<p>The <code class="code">(rnrs records inspection (6))</code> library provides procedures
useful for accessing metadata about R6RS records.
</p>
<dl class="first-deffn">
<dt class="deffn" id="index-record_003f-1"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">record?</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-record_003f-1"> &para;</a></span></dt>
<dd><p>Return <code class="code">#t</code> if the specified object is a non-opaque R6RS record,
<code class="code">#f</code> otherwise.
</p></dd></dl>
<dl class="first-deffn">
<dt class="deffn" id="index-record_002drtd"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">record-rtd</strong> <var class="def-var-arguments">record</var><a class="copiable-link" href="#index-record_002drtd"> &para;</a></span></dt>
<dd><p>Returns the record-type descriptor for <var class="var">record</var>. An
<code class="code">&amp;assertion</code> is raised if <var class="var">record</var> is opaque.
</p></dd></dl>
<dl class="first-deffn">
<dt class="deffn" id="index-record_002dtype_002dname-1"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">record-type-name</strong> <var class="def-var-arguments">rtd</var><a class="copiable-link" href="#index-record_002dtype_002dname-1"> &para;</a></span></dt>
<dd><p>Returns the name of the record-type descriptor <var class="var">rtd</var>.
</p></dd></dl>
<dl class="first-deffn">
<dt class="deffn" id="index-record_002dtype_002dparent"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">record-type-parent</strong> <var class="def-var-arguments">rtd</var><a class="copiable-link" href="#index-record_002dtype_002dparent"> &para;</a></span></dt>
<dd><p>Returns the parent of the record-type descriptor <var class="var">rtd</var>, or <code class="code">#f</code>
if it has none.
</p></dd></dl>
<dl class="first-deffn">
<dt class="deffn" id="index-record_002dtype_002duid"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">record-type-uid</strong> <var class="def-var-arguments">rtd</var><a class="copiable-link" href="#index-record_002dtype_002duid"> &para;</a></span></dt>
<dd><p>Returns the uid of the record-type descriptor <var class="var">rtd</var>, or <code class="code">#f</code> if
it has none.
</p></dd></dl>
<dl class="first-deffn">
<dt class="deffn" id="index-record_002dtype_002dgenerative_003f"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">record-type-generative?</strong> <var class="def-var-arguments">rtd</var><a class="copiable-link" href="#index-record_002dtype_002dgenerative_003f"> &para;</a></span></dt>
<dd><p>Returns <code class="code">#t</code> if the record-type descriptor <var class="var">rtd</var> is generative,
<code class="code">#f</code> otherwise.
</p></dd></dl>
<dl class="first-deffn">
<dt class="deffn" id="index-record_002dtype_002dsealed_003f"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">record-type-sealed?</strong> <var class="def-var-arguments">rtd</var><a class="copiable-link" href="#index-record_002dtype_002dsealed_003f"> &para;</a></span></dt>
<dd><p>Returns <code class="code">#t</code> if the record-type descriptor <var class="var">rtd</var> is sealed,
<code class="code">#f</code> otherwise.
</p></dd></dl>
<dl class="first-deffn">
<dt class="deffn" id="index-record_002dtype_002dopaque_003f"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">record-type-opaque?</strong> <var class="def-var-arguments">rtd</var><a class="copiable-link" href="#index-record_002dtype_002dopaque_003f"> &para;</a></span></dt>
<dd><p>Returns <code class="code">#t</code> if the record-type descriptor <var class="var">rtd</var> is opaque,
<code class="code">#f</code> otherwise.
</p></dd></dl>
<dl class="first-deffn">
<dt class="deffn" id="index-record_002dtype_002dfield_002dnames"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">record-type-field-names</strong> <var class="def-var-arguments">rtd</var><a class="copiable-link" href="#index-record_002dtype_002dfield_002dnames"> &para;</a></span></dt>
<dd><p>Returns a vector of symbols giving the names of the fields defined by
the record-type descriptor <var class="var">rtd</var> (and not any of its sub- or
supertypes).
</p></dd></dl>
<dl class="first-deffn">
<dt class="deffn" id="index-record_002dfield_002dmutable_003f"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">record-field-mutable?</strong> <var class="def-var-arguments">rtd k</var><a class="copiable-link" href="#index-record_002dfield_002dmutable_003f"> &para;</a></span></dt>
<dd><p>Returns <code class="code">#t</code> if the field at index <var class="var">k</var> of the record-type
descriptor <var class="var">rtd</var> (and not any of its sub- or supertypes) is mutable.
</p></dd></dl>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="rnrs-exceptions.html">rnrs exceptions</a>, Previous: <a href="rnrs-records-procedural.html">rnrs records procedural</a>, Up: <a href="R6RS-Standard-Libraries.html">R6RS Standard Libraries</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>