The wu-sugar Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The wu-sugar Reference Manual

This is the wu-sugar Reference Manual, version 1.0.2, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:45:13 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

wu-sugar is a small Common Lisp utility library to cut down on keystrokes. It might be similar in spirit to Alexandria, but is very minimalist.

The following functions are defined:


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 wu-sugar

Author

Wukix Inc <engineering@wukix.com>

License

BSD

Description

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

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 (file)

Component

wu-sugar.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 wu-sugar.asd

Location

wu-sugar.asd

Systems

wu-sugar (system)


Previous: , Up: Lisp files   [Contents][Index]

3.1.2 wu-sugar/wu-sugar.lisp

Parent

wu-sugar (system)

Location

wu-sugar.lisp

Packages

wu-sugar

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 wu-sugar

Source

wu-sugar.lisp (file)

Use List

common-lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: & &rest STRINGS

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

Package

wu-sugar

Source

wu-sugar.lisp (file)

Function: ends-with-p SEQ SUBSEQ
Package

wu-sugar

Source

wu-sugar.lisp (file)

Function: file-to-string FILESPEC
Package

wu-sugar

Source

wu-sugar.lisp (file)

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 (file)

Function: hash &rest REST

Make a hash table from key/value argument pairs.

Package

wu-sugar

Source

wu-sugar.lisp (file)

Function: join SEPARATOR &rest STRINGS

Concatenates STRINGS, joining them by SEPARATOR.

Package

wu-sugar

Source

wu-sugar.lisp (file)

Function: split STRING &rest DELIMITER-CHARS

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

Package

wu-sugar

Source

wu-sugar.lisp (file)

Function: starts-with-p SEQ SUBSEQ
Package

wu-sugar

Source

wu-sugar.lisp (file)

Function: str &rest VALUES
Package

wu-sugar

Source

wu-sugar.lisp (file)

Function: string-to-file STRING FILESPEC
Package

wu-sugar

Source

wu-sugar.lisp (file)

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 (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   W  
Index Entry  Section

F
File, Lisp, wu-sugar.asd: The wu-sugar<dot>asd file
File, Lisp, wu-sugar/wu-sugar.lisp: The wu-sugar/wu-sugar<dot>lisp file

L
Lisp File, wu-sugar.asd: The wu-sugar<dot>asd file
Lisp File, wu-sugar/wu-sugar.lisp: The wu-sugar/wu-sugar<dot>lisp file

W
wu-sugar.asd: The wu-sugar<dot>asd file
wu-sugar/wu-sugar.lisp: The wu-sugar/wu-sugar<dot>lisp file

Jump to:   F   L   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   &  
E   F   H   J   S   U  
Index Entry  Section

&
&: Exported functions

E
ends-with-p: Exported functions

F
file-to-string: Exported functions
format-universal-time-iso: Exported functions
Function, &: Exported functions
Function, ends-with-p: Exported functions
Function, file-to-string: Exported functions
Function, format-universal-time-iso: Exported functions
Function, hash: Exported functions
Function, join: Exported functions
Function, split: Exported functions
Function, starts-with-p: Exported functions
Function, str: Exported functions
Function, string-to-file: Exported functions
Function, universal-time-to-iso: Exported functions

H
hash: Exported functions

J
join: Exported functions

S
split: Exported functions
starts-with-p: Exported functions
str: Exported functions
string-to-file: Exported functions

U
universal-time-to-iso: Exported functions

Jump to:   &  
E   F   H   J   S   U  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   P   S   W  
Index Entry  Section

P
Package, wu-sugar: The wu-sugar package

S
System, wu-sugar: The wu-sugar system

W
wu-sugar: The wu-sugar system
wu-sugar: The wu-sugar package

Jump to:   P   S   W