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

The secret-values Reference Manual

This is the secret-values Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:51:13 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The secret-values Reference Manual, Up: The secret-values Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The secret-values Reference Manual [Contents][Index]

2 Systems

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

secret-values

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

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 <thomas@bakketun.pro>

License

MIT

Source

secret-values.asd.

Child Components

package.lisp (file).
secret-values.lisp (file).

Next: Packages, Previous: Systems, Up: The secret-values Reference Manual [Contents][Index]

3 Files

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

Lisp

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

3.1 Lisp

secret-values/secret-values.asd
secret-values/package.lisp
secret-values/secret-values.lisp

Next: secret-values/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `secret-values/secret-values.asd`

Source: secret-values.asd.
Parent Component: secret-values (system).
ASDF Systems: secret-values.

Next: secret-values/secret-values.lisp, Previous: secret-values/secret-values.asd, Up: Lisp [Contents][Index]

3.1.2 `secret-values/package.lisp`

Source: secret-values.asd.
Parent Component: secret-values (system).
Packages: secret-values.

Previous: secret-values/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `secret-values/secret-values.lisp`

Dependency

package.lisp (file).

Source

secret-values.asd.

Parent Component

secret-values (system).

Public Interface

conceal-value (function).
ensure-value-concealed (function).
ensure-value-revealed (function).
print-object (method).
reveal-value (function).
secret-value (structure).
secret-value-p (function).

Internals

copy-secret-value (function).
make-secret-value (function).
secret-value-name (reader).
(setf secret-value-name) (writer).
secret-value-symbol (reader).
(setf secret-value-symbol) (writer).

Next: Definitions, Previous: Files, Up: The secret-values Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

secret-values

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

4.1 `secret-values`

Source

package.lisp.

Use List

common-lisp.

Public Interface

conceal-value (function).
ensure-value-concealed (function).
ensure-value-revealed (function).
reveal-value (function).
secret-value (structure).
secret-value-p (function).

Internals

copy-secret-value (function).
make-secret-value (function).
secret-value-name (reader).
(setf secret-value-name) (writer).
secret-value-symbol (reader).
(setf secret-value-symbol) (writer).

Next: Indexes, Previous: Packages, Up: The secret-values Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions
Standalone methods
Structures

Next: Standalone methods, Previous: Public Interface, Up: Public Interface [Contents][Index]

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.

Next: Structures, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.2 Standalone methods

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

Source: secret-values.lisp.

Previous: Standalone methods, Up: Public Interface [Contents][Index]

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).

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

5.2 Internals

Ordinary functions

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

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.

Previous: Definitions, Up: The secret-values Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	( C E F M P R S

	Index Entry		Section

(
	`(setf secret-value-name)`:		Private ordinary functions
	`(setf secret-value-symbol)`:		Private ordinary functions

C
	`conceal-value`:		Public ordinary functions
	`copy-secret-value`:		Private ordinary functions

E
	`ensure-value-concealed`:		Public ordinary functions
	`ensure-value-revealed`:		Public ordinary functions

F
	`Function, (setf secret-value-name)`:		Private ordinary functions
	`Function, (setf secret-value-symbol)`:		Private ordinary functions
	`Function, conceal-value`:		Public ordinary functions
	`Function, copy-secret-value`:		Private ordinary functions
	`Function, ensure-value-concealed`:		Public ordinary functions
	`Function, ensure-value-revealed`:		Public ordinary functions
	`Function, make-secret-value`:		Private ordinary functions
	`Function, reveal-value`:		Public ordinary functions
	`Function, secret-value-name`:		Private ordinary functions
	`Function, secret-value-p`:		Public ordinary functions
	`Function, secret-value-symbol`:		Private ordinary functions

M
	`make-secret-value`:		Private ordinary functions
	`Method, print-object`:		Public standalone methods

P
	`print-object`:		Public standalone methods

R
	`reveal-value`:		Public ordinary functions

S
	`secret-value-name`:		Private ordinary functions
	`secret-value-p`:		Public ordinary functions
	`secret-value-symbol`:		Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

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

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

A.4 Data types

Jump to:	F P S

	Index Entry		Section

F
	`File, package.lisp`:		The secret-values/package․lisp file
	`File, secret-values.asd`:		The secret-values/secret-values․asd file
	`File, secret-values.lisp`:		The secret-values/secret-values․lisp file

P
	`Package, secret-values`:		The secret-values package
	`package.lisp`:		The secret-values/package․lisp file

S
	`secret-value`:		Public structures
	`secret-values`:		The secret-values system
	`secret-values`:		The secret-values package
	`secret-values.asd`:		The secret-values/secret-values․asd file
	`secret-values.lisp`:		The secret-values/secret-values․lisp file
	`Structure, secret-value`:		Public structures
	`System, secret-values`:		The secret-values system