The secret-values Reference Manual

This is the secret-values Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 19:32:37 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 secret-values

Secret values is a Common Lisp library designed to
reduce the risk of accidentally revealing secret values such as passwords.

Author

Thomas Bakketun <>

License

MIT

Source

secret-values.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 secret-values/secret-values.asd

Source

secret-values.asd.

Parent Component

secret-values (system).

ASDF Systems

secret-values.


3.1.2 secret-values/package.lisp

Source

secret-values.asd.

Parent Component

secret-values (system).

Packages

secret-values.


3.1.3 secret-values/secret-values.lisp

Dependency

package.lisp (file).

Source

secret-values.asd.

Parent Component

secret-values (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 secret-values

Source

package.lisp.

Use List

common-lisp.

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: conceal-value (value &key name)

Conceals value into a SECRET-VALUE object. An optional name can be provided to aid debugging.

Package

secret-values.

Source

secret-values.lisp.

Function: ensure-value-concealed (object &key name)

If object is already a of type SECRET-VALUE returns is unaltered, otherwise conceals it as if by calling CONCEAL-VALUE.

Package

secret-values.

Source

secret-values.lisp.

Function: ensure-value-revealed (object)

If object is type SECRET-VALUE returns the concealed value, otherwise returns object.

Package

secret-values.

Source

secret-values.lisp.

Function: reveal-value (secret-value)

Returns the value in SECRET-VALUE. An error of type TYPE-ERROR is signalled if the argument is not of type SECRET-VALUES.

Package

secret-values.

Source

secret-values.lisp.

Function: secret-value-p (object)
Package

secret-values.

Source

secret-values.lisp.


5.1.2 Standalone methods

Method: print-object ((object secret-value) stream)
Source

secret-values.lisp.


5.1.3 Structures

Structure: secret-value
Package

secret-values.

Source

secret-values.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: name
Readers

secret-value-name.

Writers

(setf secret-value-name).

Slot: symbol
Package

common-lisp.

Readers

secret-value-symbol.

Writers

(setf secret-value-symbol).


5.2 Internals


5.2.1 Ordinary functions

Function: copy-secret-value (instance)
Package

secret-values.

Source

secret-values.lisp.

Function: make-secret-value (&key name symbol)
Package

secret-values.

Source

secret-values.lisp.

Reader: secret-value-name (instance)
Writer: (setf secret-value-name) (instance)
Package

secret-values.

Source

secret-values.lisp.

Target Slot

name.

Reader: secret-value-symbol (instance)
Writer: (setf secret-value-symbol) (instance)
Package

secret-values.

Source

secret-values.lisp.

Target Slot

symbol.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   N   S  
Index Entry  Section

N
name: Public structures

S
Slot, name: Public structures
Slot, symbol: Public structures
symbol: Public structures