scml_base_string.md

Module scml_base_string

• Description
• Function Index
• Function Details

Scheme base library for strings

. __Authors:__ CSCM Contributor ([`the-concurrent-schemer@googlegroups.com`](mailto:the-concurrent-schemer@googlegroups.com)).

Function Index

'$scml_exports'/0
'list->string'/1	Returns a string constructed from the characters in the list. .
'make-string'/1	Equivalent to 'make-string'(K, '#\\null').
'make-string'/2	Returns a string of k characters. .
'string->list'/1	Equivalent to 'string->list'(S, 0, 'string-length'(S)).
'string->list'/2	Equivalent to 'string->list'(S, Start, 'string-length'(S)).
'string->list'/3	Returns a list of the characters of string between start and end. .
'string-append'/1	Returns a string whose characters are the concatenation of the characters in the given strings. .
'string-copy!'/3	unsupported .
'string-copy!'/4	unsupported .
'string-copy!'/5	unsupported .
'string-copy'/1	Equivalent to 'string-copy'(S, 0, 'string-length'(S)).
'string-copy'/2	Equivalent to 'string-copy'(S, Start, 'string-length'(S)).
'string-copy'/3	Returns a string constructed from the characters of string beginning with index start and ending with index end. .
'string-fill!'/2	unsupported .
'string-fill!'/3	unsupported .
'string-fill!'/4	unsupported .
'string-length'/1	Returns the number of characters in the given string. .
'string-ref'/2	Returns character k of string using zero-origin indexing. It is an error if k is not a valid index of string. .
'string-set!'/3	unsupported .
'string<=?'/1	Returns #t if all the strings are monotonically non-decreasing, otherwise returns #f. .
'string	Returns #t if all the strings are monotonically increasing, otherwise returns #f. .
'string=?'/1	Returns #t if all the strings are the same length and contain exactly the same characters in the same positions, otherwise returns #f. .
'string>=?'/1	Returns #t if all the strings are monotonically non-increasing, otherwise returns #f. .
'string>?'/1	Returns #t if all the strings are monotonically decreasing, otherwise returns #f. .
'string?'/1	Returns #t if obj is a string, otherwise returns #f. .
string/1	Returns a string composed of the arguments. .
substring/3	Equivalent to 'string-copy'(S, Start, End).

Function Details

'$scml_exports'/0

'$scml_exports'() -> [{scm_symbol(), scmi_nip()}]

'list->string'/1

'list->string'(Cs::[scm_char()]) -> scm_string()

Returns a string constructed from the characters in the list.

'make-string'/1

'make-string'(K::scm_k()) -> scm_string()

Equivalent to 'make-string'(K, '#\\null').

'make-string'/2

'make-string'(K::scm_k(), Character::scm_char()) -> scm_string()

Returns a string of k characters.

'string->list'/1

'string->list'(String::scm_string()) -> [scm_char()]

Equivalent to 'string->list'(S, 0, 'string-length'(S)).

'string->list'/2

'string->list'(String::scm_string(), Start::scm_start()) -> [scm_char()]

Equivalent to 'string->list'(S, Start, 'string-length'(S)).

'string->list'/3

'string->list'(String::scm_string(), Start::scm_start(), End::scm_end()) -> [scm_char()]

Returns a list of the characters of string between start and end.

'string-append'/1

'string-append'(Ss::[scm_string(), ...]) -> scm_string()

Returns a string whose characters are the concatenation of the characters in the given strings.

'string-copy!'/3

'string-copy!'(To::scm_bytevector(), At::scm_k(), From::scm_string()) -> scm_false()

unsupported

'string-copy!'/4

'string-copy!'(To::scm_bytevector(), At::scm_k(), From::scm_string(), Start::scm_start()) -> scm_false()

unsupported

'string-copy!'/5

'string-copy!'(To::scm_bytevector(), At::scm_k(), From::scm_string(), Start::scm_start(), End::scm_end()) -> scm_false()

unsupported

'string-copy'/1

'string-copy'(S::scm_string()) -> scm_string()

Equivalent to 'string-copy'(S, 0, 'string-length'(S)).

'string-copy'/2

'string-copy'(String::scm_string(), Start::scm_start()) -> scm_string()

Equivalent to 'string-copy'(S, Start, 'string-length'(S)).

'string-copy'/3

'string-copy'(S::scm_string(), Start::scm_start(), End::scm_end()) -> scm_string()

Returns a string constructed from the characters of string beginning with index start and ending with index end.

'string-fill!'/2

'string-fill!'(S::scm_string(), Fill::scm_char()) -> scm_false()

unsupported

'string-fill!'/3

'string-fill!'(S::scm_string(), Fill::scm_char(), Start::scm_start()) -> scm_false()

unsupported

'string-fill!'/4

'string-fill!'(S::scm_string(), Fill::scm_char(), Start::scm_start(), End::scm_end()) -> scm_false()

unsupported

'string-length'/1

'string-length'(String::scm_string()) -> scm_k()

Returns the number of characters in the given string.

'string-ref'/2

'string-ref'(String::scm_string(), K::scm_k()) -> scm_char()

Returns character k of string using zero-origin indexing. It is an error if k is not a valid index of string.

'string-set!'/3

'string-set!'(S::scm_string(), K::scm_k(), C::scm_char()) -> scm_false()

unsupported

'string<=?'/1

'string<=?'(Ss::[scm_string(), ...]) -> scm_boolean()

Returns #t if all the strings are monotonically non-decreasing, otherwise returns #f.

'string<?'/1

'string<?'(Ss::[scm_string(), ...]) -> scm_boolean()

Returns #t if all the strings are monotonically increasing, otherwise returns #f.

'string=?'/1

'string=?'(Ss::[scm_string(), ...]) -> scm_boolean()

Returns #t if all the strings are the same length and contain exactly the same characters in the same positions, otherwise returns #f.

'string>=?'/1

'string>=?'(Ss::[scm_string(), ...]) -> scm_boolean()

Returns #t if all the strings are monotonically non-increasing, otherwise returns #f.

'string>?'/1

'string>?'(Ss::[scm_string(), ...]) -> scm_boolean()

Returns #t if all the strings are monotonically decreasing, otherwise returns #f.

'string?'/1

'string?'(String::scm_obj()) -> scm_boolean()

Returns #t if obj is a string, otherwise returns #f.

string/1

string(Cs::[scm_char(), ...]) -> scm_string()

Returns a string composed of the arguments.

substring/3

substring(S::scm_string(), Start::scm_start(), End::scm_end()) -> scm_string()

Equivalent to 'string-copy'(S, Start, End).