The wu-sugar Reference Manual

This is the wu-sugar Reference Manual, version 1.0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 18:18:15 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 wu-sugar

A minimal utility library of string, file, and date functions.

Author

Wukix Inc <>

License

BSD

Long Description

A minimal utility library of string, file, and date functions. For example, STR provides string concatenation.

Version

1.0.2

Source

wu-sugar.asd.

Child Component

wu-sugar.lisp (file).


3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 wu-sugar/wu-sugar.asd

Source

wu-sugar.asd.

Parent Component

wu-sugar (system).

ASDF Systems

wu-sugar.


3.1.2 wu-sugar/wu-sugar.lisp

Source

wu-sugar.asd.

Parent Component

wu-sugar (system).

Packages

wu-sugar.

Public Interface

4 Packages

Packages are listed by definition order.


4.1 wu-sugar

Source

wu-sugar.lisp.

Use List

common-lisp.

Public Interface

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: & (&rest strings)

(concatenate ’string ...) with less typing. Note: deprecated in favor of STR.

Package

wu-sugar.

Source

wu-sugar.lisp.

Function: ends-with-p (seq subseq)
Package

wu-sugar.

Source

wu-sugar.lisp.

Function: file-to-string (filespec)
Package

wu-sugar.

Source

wu-sugar.lisp.

Function: format-universal-time-iso (stream universal-time colon atsign)

Format a universal time as an ISO 8601 / RFC 3339 date. Use with format, e.g. (format t "~/wu-sugar:format-universal-time-iso/" (get-universal-time)). If at-sign is supplied, time will be given in local time rather than UTC.

Package

wu-sugar.

Source

wu-sugar.lisp.

Function: hash (&rest rest)

Make a hash table from key/value argument pairs.

Package

wu-sugar.

Source

wu-sugar.lisp.

Function: join (separator &rest strings)

Concatenates STRINGS, joining them by SEPARATOR.

Package

wu-sugar.

Source

wu-sugar.lisp.

Function: split (string &rest delimiter-chars)

Splits STRING by one or more delimiter characters, returning a list.

Package

wu-sugar.

Source

wu-sugar.lisp.

Function: starts-with-p (seq subseq)
Package

wu-sugar.

Source

wu-sugar.lisp.

Function: str (&rest values)
Package

wu-sugar.

Source

wu-sugar.lisp.

Function: string-to-file (string filespec)
Package

wu-sugar.

Source

wu-sugar.lisp.

Function: universal-time-to-iso (universal-time &optional local-time-zone-p)

Returns an ISO 8601 / RFC 3339 formatted date/time string either in UTC (the default), or the local time zone.

Package

wu-sugar.

Source

wu-sugar.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables