The cl-dotenv Reference Manual

This is the cl-dotenv Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:54:13 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-dotenv

Utility library for loading .env files

Author

Olle Lauri Boström

License

MIT

Version

0.1.0

Dependencies
  • alexandria (system).
  • serapeum (system).
Source

cl-dotenv.asd.

Child Component

cl-dotenv.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 cl-dotenv/cl-dotenv.asd

Source

cl-dotenv.asd.

Parent Component

cl-dotenv (system).

ASDF Systems

cl-dotenv.


3.1.2 cl-dotenv/cl-dotenv.lisp

Source

cl-dotenv.asd.

Parent Component

cl-dotenv (system).

Packages

cl-dotenv.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-dotenv

.ENV files are parsed according to the following rules.

∙ Empty lines are skipped.
∙ Lines beginning with # are treated as comments
∙ Empty values are treated as empty strings, e.j. ’EMPTY=’ sets the environment variable EMPTY to ”.

Source

cl-dotenv.lisp.

Nicknames
  • dotenv
  • .env
Use List
  • alexandria.
  • common-lisp.
  • serapeum.
Public Interface
Internals

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: load-env (path)
Package

cl-dotenv.

Source

cl-dotenv.lisp.

Function: read-env (path)
Package

cl-dotenv.

Source

cl-dotenv.lisp.


5.1.2 Conditions

Condition: duplicated-entry
Package

cl-dotenv.

Source

cl-dotenv.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: key
Initargs

:key

Readers

key.

Writers

This slot is read-only.

Slot: prev-value
Initargs

:prev-value

Readers

prev-value.

Writers

This slot is read-only.

Slot: value
Initargs

:value

Readers

value.

Writers

This slot is read-only.

Condition: malformed-entry
Package

cl-dotenv.

Source

cl-dotenv.lisp.

Direct superclasses

error.

Direct methods

line.

Direct slots
Slot: line
Initargs

:line

Readers

line.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Ordinary functions

Function: %load-env (env)
Package

cl-dotenv.

Source

cl-dotenv.lisp.

Function: read-entry (line)
Package

cl-dotenv.

Source

cl-dotenv.lisp.

Function: whitespace-p (char)
Package

cl-dotenv.

Source

cl-dotenv.lisp.


5.2.2 Generic functions

Generic Reader: key (condition)
Package

cl-dotenv.

Methods
Reader Method: key ((condition duplicated-entry))
Source

cl-dotenv.lisp.

Target Slot

key.

Generic Reader: line (condition)
Package

cl-dotenv.

Methods
Reader Method: line ((condition malformed-entry))
Source

cl-dotenv.lisp.

Target Slot

line.

Generic Reader: prev-value (condition)
Package

cl-dotenv.

Methods
Reader Method: prev-value ((condition duplicated-entry))
Source

cl-dotenv.lisp.

Target Slot

prev-value.

Generic Reader: value (condition)
Package

cl-dotenv.

Methods
Reader Method: value ((condition duplicated-entry))
Source

cl-dotenv.lisp.

Target Slot

value.


Appendix A Indexes


A.1 Concepts


A.3 Variables