1
0
Fork 0
cl-sites/guile.html_node/Bytevectors-as-Strings.html
2024-12-17 12:49:28 +01:00

116 lines
9.4 KiB
HTML

<!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>Bytevectors as Strings (Guile Reference Manual)</title>
<meta name="description" content="Bytevectors as Strings (Guile Reference Manual)">
<meta name="keywords" content="Bytevectors as Strings (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="Bytevectors.html" rel="up" title="Bytevectors">
<link href="Bytevectors-as-Arrays.html" rel="next" title="Bytevectors as Arrays">
<link href="Bytevectors-as-Floats.html" rel="prev" title="Bytevectors as Floats">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
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="Bytevectors-as-Strings">
<div class="nav-panel">
<p>
Next: <a href="Bytevectors-as-Arrays.html" accesskey="n" rel="next">Accessing Bytevectors with the Array API</a>, Previous: <a href="Bytevectors-as-Floats.html" accesskey="p" rel="prev">Interpreting Bytevector Contents as Floating Point Numbers</a>, Up: <a href="Bytevectors.html" accesskey="u" rel="up">Bytevectors</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="Interpreting-Bytevector-Contents-as-Unicode-Strings"><span>6.6.12.6 Interpreting Bytevector Contents as Unicode Strings<a class="copiable-link" href="#Interpreting-Bytevector-Contents-as-Unicode-Strings"> &para;</a></span></h4>
<a class="index-entry-id" id="index-Unicode-string-encoding"></a>
<p>Bytevector contents can also be interpreted as Unicode strings encoded
in one of the most commonly available encoding formats.
See <a class="xref" href="Representing-Strings-as-Bytes.html">Representing Strings as Bytes</a>, for a more generic interface.
</p>
<div class="example lisp">
<pre class="lisp-preformatted">(utf8-&gt;string (u8-list-&gt;bytevector '(99 97 102 101)))
&rArr; &quot;cafe&quot;
(string-&gt;utf8 &quot;caf&eacute;&quot;) ;; SMALL LATIN LETTER E WITH ACUTE ACCENT
&rArr; #vu8(99 97 102 195 169)
</pre></div>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-string_002dutf8_002dlength"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">string-utf8-length</strong> <code class="def-code-arguments">str</code><a class="copiable-link" href="#index-string_002dutf8_002dlength"> &para;</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-scm_005fstring_005futf8_005flength"><span class="category-def">C function: </span><span><code class="def-type">SCM</code> <strong class="def-name">scm_string_utf8_length</strong> <code class="def-code-arguments">(str)</code><a class="copiable-link" href="#index-scm_005fstring_005futf8_005flength"> &para;</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-scm_005fc_005fstring_005futf8_005flength"><span class="category-def">C function: </span><span><code class="def-type">size_t</code> <strong class="def-name">scm_c_string_utf8_length</strong> <code class="def-code-arguments">(str)</code><a class="copiable-link" href="#index-scm_005fc_005fstring_005futf8_005flength"> &para;</a></span></dt>
<dd><p>Return the number of bytes in the UTF-8 representation of <var class="var">str</var>.
</p></dd></dl>
<dl class="first-deffn">
<dt class="deffn" id="index-string_002d_003eutf8"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">string-&gt;utf8</strong> <var class="def-var-arguments">str</var><a class="copiable-link" href="#index-string_002d_003eutf8"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-string_002d_003eutf16"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">string-&gt;utf16</strong> <var class="def-var-arguments">str [endianness]</var><a class="copiable-link" href="#index-string_002d_003eutf16"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-string_002d_003eutf32"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">string-&gt;utf32</strong> <var class="def-var-arguments">str [endianness]</var><a class="copiable-link" href="#index-string_002d_003eutf32"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fstring_005fto_005futf8"><span class="category-def">C Function: </span><span><strong class="def-name">scm_string_to_utf8</strong> <var class="def-var-arguments">(str)</var><a class="copiable-link" href="#index-scm_005fstring_005fto_005futf8"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fstring_005fto_005futf16"><span class="category-def">C Function: </span><span><strong class="def-name">scm_string_to_utf16</strong> <var class="def-var-arguments">(str, endianness)</var><a class="copiable-link" href="#index-scm_005fstring_005fto_005futf16"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fstring_005fto_005futf32"><span class="category-def">C Function: </span><span><strong class="def-name">scm_string_to_utf32</strong> <var class="def-var-arguments">(str, endianness)</var><a class="copiable-link" href="#index-scm_005fstring_005fto_005futf32"> &para;</a></span></dt>
<dd><p>Return a newly allocated bytevector that contains the UTF-8, UTF-16, or
UTF-32 (aka. UCS-4) encoding of <var class="var">str</var>. For UTF-16 and UTF-32,
<var class="var">endianness</var> should be the symbol <code class="code">big</code> or <code class="code">little</code>; when omitted,
it defaults to big endian.
</p></dd></dl>
<dl class="first-deffn">
<dt class="deffn" id="index-utf8_002d_003estring"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">utf8-&gt;string</strong> <var class="def-var-arguments">utf</var><a class="copiable-link" href="#index-utf8_002d_003estring"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-utf16_002d_003estring"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">utf16-&gt;string</strong> <var class="def-var-arguments">utf [endianness]</var><a class="copiable-link" href="#index-utf16_002d_003estring"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-utf32_002d_003estring"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">utf32-&gt;string</strong> <var class="def-var-arguments">utf [endianness]</var><a class="copiable-link" href="#index-utf32_002d_003estring"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005futf8_005fto_005fstring"><span class="category-def">C Function: </span><span><strong class="def-name">scm_utf8_to_string</strong> <var class="def-var-arguments">(utf)</var><a class="copiable-link" href="#index-scm_005futf8_005fto_005fstring"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005futf16_005fto_005fstring"><span class="category-def">C Function: </span><span><strong class="def-name">scm_utf16_to_string</strong> <var class="def-var-arguments">(utf, endianness)</var><a class="copiable-link" href="#index-scm_005futf16_005fto_005fstring"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005futf32_005fto_005fstring"><span class="category-def">C Function: </span><span><strong class="def-name">scm_utf32_to_string</strong> <var class="def-var-arguments">(utf, endianness)</var><a class="copiable-link" href="#index-scm_005futf32_005fto_005fstring"> &para;</a></span></dt>
<dd><p>Return a newly allocated string that contains from the UTF-8-, UTF-16-,
or UTF-32-decoded contents of bytevector <var class="var">utf</var>. For UTF-16 and UTF-32,
<var class="var">endianness</var> should be the symbol <code class="code">big</code> or <code class="code">little</code>; when omitted,
it defaults to big endian.
</p></dd></dl>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Bytevectors-as-Arrays.html">Accessing Bytevectors with the Array API</a>, Previous: <a href="Bytevectors-as-Floats.html">Interpreting Bytevector Contents as Floating Point Numbers</a>, Up: <a href="Bytevectors.html">Bytevectors</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>