diff options
author | Marius Vollmer <mvo@zagadka.de> | 2004-09-22 14:46:18 +0000 |
---|---|---|
committer | Marius Vollmer <mvo@zagadka.de> | 2004-09-22 14:46:18 +0000 |
commit | 052567604f2b90eaaa93bafea4898d3af030551b (patch) | |
tree | df8a7a00cb5275bdf4a29275e2ea86208c0ce1c8 | |
parent | 5dfdf243d2521287e4579905c01f88ee1015d987 (diff) | |
download | guile-052567604f2b90eaaa93bafea4898d3af030551b.tar.gz |
Docs for substring/read-only.
-rwxr-xr-x | doc/ref/api-data.texi | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/ref/api-data.texi b/doc/ref/api-data.texi index 51421a530..08dab67d7 100755 --- a/doc/ref/api-data.texi +++ b/doc/ref/api-data.texi @@ -2407,6 +2407,8 @@ strings created by this procedure are called @dfn{mutation sharing substrings} since the substring and the original string share modifications to each other. +If you want to prevent modifications, use @code{substring/read-only}. + Guile provides all procedures of SRFI-13 and a few more. @menu @@ -2725,9 +2727,15 @@ Like @code{substring}, but the storage for the new string is copied immediately. @end deffn +@deffn {Scheme Procedure} substring/read-only str start [end] +@deffnx {C Function} scm_substring_read_only (str, start, end) +Like @code{substring}, but the resulting string can not be modified. +@end deffn + @deftypefn {C Function} SCM scm_c_substring (SCM str, size_t start, size_t end) @deftypefnx {C Function} SCM scm_c_substring_shared (SCM str, size_t start, size_t end) @deftypefnx {C Function} SCM scm_c_substring_copy (SCM str, size_t start, size_t end) +@deftypefnx {C Function} SCM scm_c_substring_read_only (SCM str, size_t start, size_t end) Like @code{scm_substring}, etc. but the bounds are given as a @code{size_t}. @end deftypefn |