# Miscellaneous

# Buffered channels.

# make-channel

(make-channel ...)

Please document me!

# channel?

(channel? ...)

Please document me!

# channel-put

(channel-put ...)

Please document me!

# channel-try-put

(channel-try-put ...)

Please document me!

# channel-sync

(channel-sync ...)

Please document me!

# channel-get

(channel-get ...)

Please document me!

# channel-try-get

(channel-try-get ...)

Please document me!

# channel-close

(channel-close ...)

Please document me!

# channel-closed?

(channel-closed? ...)

Please document me!

# Asynchronous Completions

# make-completion

(make-completion ...)

Please document me!

# completion?

(completion? ...)

Please document me!

# completion-ready?

(completion-ready? ...)

Please document me!

# completion-wait!

(completion-wait! ...)

Please document me!

# completion-post!

(completion-post! ...)

Please document me!

# completion-error!

(completion-error! ...)

Please document me!

# with-completion-error

(with-completion-error ...)

Please document me!

# List utilities

# alist?

(alist? ...)

Please document me!

# plist?

(plist? ...)

Please document me!

# plist->alist

(plist->alist ...)

Please document me!

# alist->plist

(alist->plist ...)

Please document me!

# length=?

(length=? ...)

Please document me!

# length=n?

(length=n? ...)

Please document me!

# length<?

(length<? ...)

Please document me!

# length<n?

(length<n? ...)

Please document me!

# length<=?

(length<=? ...)

Please document me!

# length<=n?

(length<=n? ...)

Please document me!

# length>?

(length>? ...)

Please document me!

# length>n?

(length>n? ...)

Please document me!

# length>=?

(length>=? ...)

Please document me!

# length>=n?

(length>=n? ...)

Please document me!

# call-with-list-builder

(call-with-list-builder ...)

Please document me!

# with-list-builder

(with-list-builder ...)

Please document me!

# snoc

(snoc ...)

Please document me!

# append1

(append1 ...)

Please document me!

# for-each!

(for-each! ...)

Please document me!

# push!

(push! ...)

Please document me!

# flatten1

> (flatten1 [1 [2]])
=> (1 2)

> (flatten1 [1 [2] [[3]]])
=> (1 2 (3))

Removes one layer of a nested proper list.

# flatten

> (flatten [1 [2]])
=> (1 2)

> (flatten [1 [2] [[3]]])
=> (1 2 3)

Removes all nested layers of a proper list.

# LRU caches

# make-lru-cache

(make-lru-cache ...)

Please document me!

# lru-cache?

(lru-cache? ...)

Please document me!

# lru-cache-ref

(lru-cache-ref ...)

Please document me!

# lru-cache-get

(lru-cache-get ...)

Please document me!

# lru-cache-put!

(lru-cache-put! ...)

Please document me!

# lru-cache-remove!

(lru-cache-remove! ...)

Please document me!

# lru-cache-size

(lru-cache-size ...)

Please document me!

# lru-cache-capacity

(lru-cache-capacity ...)

Please document me!

# lru-cache-flush!

(lru-cache-flush! ...)

Please document me!

# lru-cache-walk

(lru-cache-walk ...)

Please document me!

# lru-cache-fold

(lru-cache-fold ...)

Please document me!

# lru-cache-foldr

(lru-cache-foldr ...)

Please document me!

# lru-cache->list

(lru-cache->list ...)

Please document me!

# Port utilities

# copy-port

(copy-port ...)

Please document me!

# read-all-as-string

(read-all-as-string ...)

Please document me!

# read-file-string

(read-file-string ...)

Please document me!

# read-all-as-lines

(read-all-as-lines ...)

Please document me!

# read-file-lines

(read-file-lines ...)

Please document me!

# Port Destructor

(defmethod {destroy <port>} close-port)

The module also defines a destroy method for ports, so that they can be used in with-destroy forms and other primitives that use the destroy idiom.

# Priority Queues

# make-pqueue

(make-pqueue ...)

Please document me!

# pqueue?

(pqueue? ...)

Please document me!

# pqueue-empty?

(pqueue-empty? ...)

Please document me!

# pqueue-size

(pqueue-size ...)

Please document me!

# pqueue-peek

(pqueue-peek ...)

Please document me!

# pqueue-pop!

(pqueue-pop! ...)

Please document me!

# pqueue-push!

(pqueue-push! ...)

Please document me!

# Proces Utilities

# Overview

These utilities synchronously spawn a subprocess, spawn a coprocess function in a thread to interact with the process (default: std/misc/ports#read-all-as-string), check the status of the process upon termination, and return the result of that coprocess if successful.

# run-process

(run-process ...)

Please document me!

# run-process/batch

(run-process/batch ...)

Please document me!

# Deques

# make-queue

(make-queue ...)

Please document me!

# queue?

(queue? ...)

Please document me!

# queue-length

(queue-length ...)

Please document me!

# queue-empty?

(queue-empty? ...)

Please document me!

# non-empty-queue?

(non-empty-queue? ...)

Please document me!

# enqueue!

(enqueue! ...)

Please document me!

# enqueue-front!

(enqueue-front! ...)

Please document me!

# dequeue!

(dequeue! ...)

Please document me!

# queue->list

(queue->list ...)

Please document me!

# Sourceable Representation

# print-representation

(print-representation obj [port = (current-output-port)] [options = (current-representation-options)])

print-representation is a function (also available with the short-hand name pr) that takes an object, optionally a port and a table of options, and displays on that port source-code representation of the object that can be evaluated back into an equivalent object.

Behavior of print-representation can be specialized for new classes of objects by defining new methods on :pr, as in:

(defmethod {:pr my-class}
  (lambda (self port options)
    ...))

# pr

(defalias pr print-representation)

Same as print-representation.

# prn

(prn ...)

prn does the same as pr then follows with a newline.

# repr

(repr obj [options = (current-representation-options)])

repr does not take a port as argument and instead returns the representation as a string.

# representable

(defclass representable ())

representable is an abstract mixin class that defines a method for :pr. By default, if a class does not provide its own implementation, that method will call print-unrepresentable-object.

# print-unrepresentable-object

(print-unrepresentable-object obj [port = (current-output-port)] [options = (current-representation-options)])

print-unrepresentable-object is a helper function to use as fallback for objects that can't otherwise be displayed.

# default-representation-options

(def default-representation-options)

default-representation-options is the default table of options. No options are currently defined, and the default table is currently empty. In the future, options may be defined for pretty-printing, etc.

# current-representation-options

(current-representation-options [options])

current-representation-options is a parameter returning the current options, and initially returns the default-representation-options.

# display-separated

(display-separated lst [port = (current-output-port)]
                   [prefix: prefix = ""]
                   [separator: separator = " "]
                   [suffix: suffix = ""]
                   [display-element: disp = display])

display-separated is a helper function that takes a list of objects, an optional port, and as keywords a prefix: string (empty by default), a suffix: string (empty by default), a separator string (defaulting to a single space " "), and a display-element: function (the function display by default), and displays each element of the list with the given prefix, suffix, separator and display function.

# Type Descriptor Utilities.

# object-type

(object-type ...)

Please document me!

# type?

(type? ...)

Please document me!

# type-id

(type-id ...)

Please document me!

# type-name

(type-name ...)

Please document me!

# type-super

(type-super ...)

Please document me!

# type-descriptor?

(type-descriptor? ...)

Please document me!

# type-descriptor-mixin

(type-descriptor-mixin ...)

Please document me!

# type-descriptor-fields

(type-descriptor-fields ...)

Please document me!

# type-descriptor-plist

(type-descriptor-plist ...)

Please document me!

# type-descriptor-ctor

(type-descriptor-ctor ...)

Please document me!

# type-descriptor-slots

(type-descriptor-slots ...)

Please document me!

# type-descriptor-methods

(type-descriptor-methods ...)

Please document me!

# Shared-structure Equality.

# equal-shared?

(equal-shared? ...)

Please document me!

# Shuffling

# shuffle

(shuffle ...)

Please document me!

# vector-shuffle

(vector-shuffle ...)

Please document me!

# vector-shuffle!

(vector-shuffle! ...)

Please document me!

# String utilities

# string-split-prefix

(string-split-prefix ...)

Please document me!

# string-trim-prefix

(string-trim-prefix ...)

Please document me!

# string-split-suffix

(string-split-suffix ...)

Please document me!

# string-trim-suffix

(string-trim-suffix ...)

Please document me!

# string-split-eol

(string-split-eol ...)

Please document me!

# string-trim-eol

(string-trim-eol ...)

Please document me!

# +cr+

(def +cr+)

Please document me!

# +lf+

(def +lf+)

Please document me!

# +crlf+

(def +crlf+)

Please document me!

# Synchronized Data Structures.

# make-sync-hash

(make-sync-hash ...)

Please document me!

# sync-hash?

(sync-hash? ...)

Please document me!

# sync-hash-get

(sync-hash-get ...)

Please document me!

# sync-hash-ref

(sync-hash-ref ...)

Please document me!

# sync-hash-key?

(sync-hash-key? ...)

Please document me!

# sync-hash-put!

(sync-hash-put! ...)

Please document me!

# sync-hash-remove!

(sync-hash-remove! ...)

Please document me!

# sync-hash-do

(sync-hash-do ...)

Please document me!

# Text Utilities

# include-text

(include-text ...)

Please document me!

# Thread utilities

# primordial-thread-group

(primordial-thread-group ...)

Please document me!

# thread-group->thread-list*

(thread-group->thread-list* ...)

Please document me!

# all-threads

(all-threads ...)

Please document me!

# thread-dead?

(thread-dead? ...)

Please document me!

# thread-group-kill!

(thread-group-kill! ...)

Please document me!

# thread-raise!

(thread-raise! ...)

Please document me!

# thread-abort!

(thread-abort! ...)

Please document me!

# thread-abort?

(thread-abort? ...)

Please document me!

# thread-async!

(thread-async! ...)

Please document me!

# on-all-processors

(on-all-processors ...)

Please document me!

# Timeouts

# make-timeout

(make-timeout ...)

Please document me!

# UUIDs

# UUID

(UUID ...)

Please document me!

# uuid-length

(uuid-length ...)

Please document me!

# uuid::t

(uuid::t ...)

Please document me!

# make-uuid

(make-uuid ...)

Please document me!

# uuid?

(uuid? ...)

Please document me!

# uuid=?

(uuid=? ...)

Please document me!

# uuid-hash

(uuid-hash ...)

Please document me!

# uuid->u8vector

(uuid->u8vector ...)

Please document me!

# u8vector->uuid

(u8vector->uuid ...)

Please document me!

# uuid->string

(uuid->string ...)

Please document me!

# string->uuid

(string->uuid ...)

Please document me!

# random-uuid

(random-uuid ...)

Please document me!

# Functional utilities

Collection of mixed purpose higher-order functions.

# always

> (def fn (always 5))
> (list (fn) (fn))
=> (5 5)

> (def fn (always (lambda () "hi")))
> (fn)
=> "hi"

> (def fn (always random-integer 10)
> (list (fn) (fn))
=> (4 3)

Creates a lambda which returns the same value or calls always the same function with the same arguments.

# repeat

> (repeat 2 5)
=> (2 2 2 2 2)

> (repeat (lambda () 10) 2)
=> (10 10)

> (repeat random-integer 3 10)
=> (8 3 5)

Repeat value or call function N times and return the result as list.