The cl-gists Reference Manual

This is the cl-gists Reference Manual, version 0.2.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:02:45 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-gists

Gists API Wrapper for Common Lisp.

Maintainer

Steve Nunez

Author

Rudolph Miller

Home Page

https://github.com/Symbolics/cl-gists

License

MS-PL

Version

0.2.1

Dependencies
  • alexandria (system).
  • alexandria+ (system).
  • local-time (system).
  • quri (system).
  • dexador (system).
  • babel (system).
  • yason (system).
Source

cl-gists.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-gists/src

Source

cl-gists.asd.

Parent Component

cl-gists (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 cl-gists/cl-gists.asd

Source

cl-gists.asd.

Parent Component

cl-gists (system).

ASDF Systems

cl-gists.


4.1.2 cl-gists/src/util.lisp

Source

cl-gists.asd.

Parent Component

src (module).

Packages

cl-gists.util.

Public Interface
Internals

*raw-keyword* (special variable).


4.1.3 cl-gists/src/user.lisp

Dependency

util.lisp (file).

Source

cl-gists.asd.

Parent Component

src (module).

Packages

cl-gists.user.

Public Interface
Internals

4.1.4 cl-gists/src/file.lisp

Dependency

user.lisp (file).

Source

cl-gists.asd.

Parent Component

src (module).

Packages

cl-gists.file.

Public Interface
Internals

4.1.5 cl-gists/src/fork.lisp

Dependency

file.lisp (file).

Source

cl-gists.asd.

Parent Component

src (module).

Packages

cl-gists.fork.

Public Interface
Internals

4.1.6 cl-gists/src/history.lisp

Dependency

fork.lisp (file).

Source

cl-gists.asd.

Parent Component

src (module).

Packages

cl-gists.history.

Public Interface
Internals

4.1.7 cl-gists/src/gist.lisp

Dependency

history.lisp (file).

Source

cl-gists.asd.

Parent Component

src (module).

Packages

cl-gists.gist.

Public Interface
Internals

4.1.8 cl-gists/src/api.lisp

Dependency

gist.lisp (file).

Source

cl-gists.asd.

Parent Component

src (module).

Packages

cl-gists.api.

Public Interface
Internals

4.1.9 cl-gists/src/pkgdcl.lisp

Dependency

api.lisp (file).

Source

cl-gists.asd.

Parent Component

src (module).

Packages

cl-gists.


5 Packages

Packages are listed by definition order.


5.1 cl-gists.history

Source

history.lisp.

Use List
Used By List
Public Interface
Internals

5.2 cl-gists.api

Source

api.lisp.

Use List
Public Interface
Internals

5.3 cl-gists

Source

pkgdcl.lisp.

Nickname

gists

Use List

common-lisp.


5.4 cl-gists.user

Source

user.lisp.

Use List

common-lisp.

Used By List
Public Interface
Internals

5.5 cl-gists.gist

Source

gist.lisp.

Use List
Used By List

cl-gists.api.

Public Interface
Internals

5.6 cl-gists.file

Source

file.lisp.

Use List
Used By List
Public Interface
Internals

5.7 cl-gists.fork

Source

fork.lisp.

Use List
Used By List
Public Interface
Internals

5.8 cl-gists.util

Source

util.lisp.

Use List

common-lisp.

Used By List
Public Interface
Internals

*raw-keyword* (special variable).


6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *credentials*

Global variable of credentials.

Package

cl-gists.util.

Source

util.lisp.

Special Variable: *github-oauth-token-env-var*

Environment variable for a OAuth token of GitHub.

Package

cl-gists.util.

Source

util.lisp.

Special Variable: *github-password-env-var*

Environment variable for a password of GitHub.

Package

cl-gists.util.

Source

util.lisp.

Special Variable: *github-username-env-var*

Environment variable for a username of GitHub.

Package

cl-gists.util.

Source

util.lisp.


6.1.2 Ordinary functions

Function: create-gist (gist)

Create a gist.

Package

cl-gists.api.

Source

api.lisp.

Function: delete-gist (id-or-gist)

Delete a gist.

Package

cl-gists.api.

Source

api.lisp.

Function: delete-request (uri &key content)
Package

cl-gists.util.

Source

util.lisp.

Function: edit-gist (gist)

Edit a gist.

Package

cl-gists.api.

Source

api.lisp.

Reader: file-content (instance)
Writer: (setf file-content) (instance)
Package

cl-gists.file.

Source

file.lisp.

Target Slot

content.

Reader: file-language (instance)
Writer: (setf file-language) (instance)
Package

cl-gists.file.

Source

file.lisp.

Target Slot

language.

Reader: file-name (instance)
Writer: (setf file-name) (instance)
Package

cl-gists.file.

Source

file.lisp.

Target Slot

name.

Reader: file-old-name (instance)
Package

cl-gists.file.

Source

file.lisp.

Target Slot

old-name.

Reader: file-raw-url (instance)
Writer: (setf file-raw-url) (instance)
Package

cl-gists.file.

Source

file.lisp.

Target Slot

raw-url.

Reader: file-size (instance)
Writer: (setf file-size) (instance)
Package

cl-gists.file.

Source

file.lisp.

Target Slot

size.

Reader: file-truncated (instance)
Writer: (setf file-truncated) (instance)
Package

cl-gists.file.

Source

file.lisp.

Target Slot

truncated.

Reader: file-type (instance)
Writer: (setf file-type) (instance)
Package

cl-gists.file.

Source

file.lisp.

Target Slot

type.

Reader: fork-created-at (instance)
Writer: (setf fork-created-at) (instance)
Package

cl-gists.fork.

Source

fork.lisp.

Target Slot

created-at.

Function: fork-gist (id-or-gist)

Fork a gist.

Package

cl-gists.api.

Source

api.lisp.

Reader: fork-id (instance)
Writer: (setf fork-id) (instance)
Package

cl-gists.fork.

Source

fork.lisp.

Target Slot

id.

Reader: fork-updated-at (instance)
Writer: (setf fork-updated-at) (instance)
Package

cl-gists.fork.

Source

fork.lisp.

Target Slot

updated-at.

Reader: fork-url (instance)
Writer: (setf fork-url) (instance)
Package

cl-gists.fork.

Source

fork.lisp.

Target Slot

url.

Reader: fork-user (instance)
Writer: (setf fork-user) (instance)
Package

cl-gists.fork.

Source

fork.lisp.

Target Slot

user.

Function: format-timestring-for-api (timestamp)
Package

cl-gists.util.

Source

util.lisp.

Function: get-gist (id &key sha)

Get a single gist.

Package

cl-gists.api.

Source

api.lisp.

Function: get-request (uri &key ignore-statuses)
Package

cl-gists.util.

Source

util.lisp.

Reader: gist-comments (instance)
Writer: (setf gist-comments) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

comments.

Reader: gist-comments-url (instance)
Writer: (setf gist-comments-url) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

comments-url.

Reader: gist-commits-url (instance)
Writer: (setf gist-commits-url) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

commits-url.

Reader: gist-created-at (instance)
Writer: (setf gist-created-at) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

created-at.

Reader: gist-description (instance)
Writer: (setf gist-description) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

description.

Reader: gist-files (instance)
Writer: (setf gist-files) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

files.

Reader: gist-fork-of (instance)
Writer: (setf gist-fork-of) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

fork-of.

Reader: gist-forks (instance)
Writer: (setf gist-forks) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

forks.

Reader: gist-forks-url (instance)
Writer: (setf gist-forks-url) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

forks-url.

Reader: gist-git-pull-url (instance)
Writer: (setf gist-git-pull-url) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

git-pull-url.

Reader: gist-git-push-url (instance)
Writer: (setf gist-git-push-url) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

git-push-url.

Reader: gist-history (instance)
Writer: (setf gist-history) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

history.

Reader: gist-html-url (instance)
Writer: (setf gist-html-url) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

html-url.

Reader: gist-id (instance)
Writer: (setf gist-id) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

id.

Reader: gist-owner (instance)
Writer: (setf gist-owner) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

owner.

Reader: gist-public (instance)
Writer: (setf gist-public) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

public.

Function: gist-starred-p (id-or-gist)

Check if a gist starred.

Package

cl-gists.api.

Source

api.lisp.

Reader: gist-updated-at (instance)
Writer: (setf gist-updated-at) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

updated-at.

Reader: gist-url (instance)
Writer: (setf gist-url) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

url.

Reader: gist-user (instance)
Writer: (setf gist-user) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

user.

Reader: history-additions (instance)
Writer: (setf history-additions) (instance)
Package

cl-gists.history.

Source

history.lisp.

Target Slot

additions.

Reader: history-committed-at (instance)
Writer: (setf history-committed-at) (instance)
Package

cl-gists.history.

Source

history.lisp.

Target Slot

committed-at.

Reader: history-deletions (instance)
Writer: (setf history-deletions) (instance)
Package

cl-gists.history.

Source

history.lisp.

Target Slot

deletions.

Reader: history-total (instance)
Writer: (setf history-total) (instance)
Package

cl-gists.history.

Source

history.lisp.

Target Slot

total.

Reader: history-url (instance)
Writer: (setf history-url) (instance)
Package

cl-gists.history.

Source

history.lisp.

Target Slot

url.

Reader: history-user (instance)
Writer: (setf history-user) (instance)
Package

cl-gists.history.

Source

history.lisp.

Target Slot

user.

Reader: history-version (instance)
Writer: (setf history-version) (instance)
Package

cl-gists.history.

Source

history.lisp.

Target Slot

version.

Function: list-gist-commits (id-or-gist)

List gist commits.

Package

cl-gists.api.

Source

api.lisp.

Function: list-gist-forks (id-or-gist)

List gist forks.

Package

cl-gists.api.

Source

api.lisp.

Function: list-gists (&key username public starred since)

List gists

Package

cl-gists.api.

Source

api.lisp.

Function: make-file (&key name size raw-url type truncated language content old-name)
Package

cl-gists.file.

Source

file.lisp.

Function: make-files (list)
Package

cl-gists.file.

Source

file.lisp.

Function: make-fork (&key user url id created-at updated-at)
Package

cl-gists.fork.

Source

fork.lisp.

Function: make-forks (list)
Package

cl-gists.fork.

Source

fork.lisp.

Function: make-gist (&key url forks-url commits-url id description public owner fork-of user files comments comments-url html-url git-pull-url git-push-url created-at updated-at forks history truncated node-id)
Package

cl-gists.gist.

Source

gist.lisp.

Function: make-gists (list)
Package

cl-gists.gist.

Source

gist.lisp.

Function: make-histories (list)
Package

cl-gists.history.

Source

history.lisp.

Function: make-history (&key url version user deletions additions total committed-at)
Package

cl-gists.history.

Source

history.lisp.

Function: make-user (&key login id avatar-url gravatar-id url html-url followers-url following-url gists-url starred-url subscriptions-url organizations-url repos-url events-url received-events-url type site-admin node-id)
Package

cl-gists.user.

Source

user.lisp.

Function: parse-json (json)
Package

cl-gists.util.

Source

util.lisp.

Function: patch-request (uri &key content)
Package

cl-gists.util.

Source

util.lisp.

Function: post-request (uri &key content)
Package

cl-gists.util.

Source

util.lisp.

Function: put-request (uri &key content)
Package

cl-gists.util.

Source

util.lisp.

Function: request (uri &key method content ignore-statuses credentials)
Package

cl-gists.util.

Source

util.lisp.

Function: star-gist (id-or-gist)

Star a gist.

Package

cl-gists.api.

Source

api.lisp.

Function: unstar-gist (id-or-gist)

Unstar a gist.

Package

cl-gists.api.

Source

api.lisp.

Reader: user-avatar-url (instance)
Writer: (setf user-avatar-url) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

avatar-url.

Reader: user-events-url (instance)
Writer: (setf user-events-url) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

events-url.

Reader: user-followers-url (instance)
Writer: (setf user-followers-url) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

followers-url.

Reader: user-following-url (instance)
Writer: (setf user-following-url) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

following-url.

Reader: user-gists-url (instance)
Writer: (setf user-gists-url) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

gists-url.

Reader: user-html-url (instance)
Writer: (setf user-html-url) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

html-url.

Reader: user-id (instance)
Writer: (setf user-id) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

id.

Reader: user-login (instance)
Writer: (setf user-login) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

login.

Reader: user-organizations-url (instance)
Writer: (setf user-organizations-url) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

organizations-url.

Reader: user-received-events-url (instance)
Writer: (setf user-received-events-url) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

received-events-url.

Reader: user-repos-url (instance)
Writer: (setf user-repos-url) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

repos-url.

Reader: user-site-admin (instance)
Writer: (setf user-site-admin) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

site-admin.

Reader: user-starred-url (instance)
Writer: (setf user-starred-url) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

starred-url.

Reader: user-subscriptions-url (instance)
Writer: (setf user-subscriptions-url) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

subscriptions-url.

Reader: user-type (instance)
Writer: (setf user-type) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

type.

Reader: user-url (instance)
Writer: (setf user-url) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

url.


6.1.3 Generic functions

Generic Function: oauth-token (credentials)

Return the OAuth token.

Package

cl-gists.util.

Source

util.lisp.

Methods
Method: oauth-token (credentials)
Generic Function: password (credentials)

Return the password.

Package

cl-gists.util.

Source

util.lisp.

Methods
Method: password (credentials)
Generic Function: username (credentials)

Return the username.

Package

cl-gists.util.

Source

util.lisp.

Methods
Method: username (credentials)

6.1.4 Structures

Structure: file

Structure of File.

Package

cl-gists.file.

Source

file.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: name
Type

(or null string)

Readers

file-name.

Writers

(setf file-name).

Slot: size
Type

(or null integer)

Readers

file-size.

Writers

(setf file-size).

Slot: raw-url
Type

(or null string)

Readers

file-raw-url.

Writers

(setf file-raw-url).

Slot: type
Package

common-lisp.

Type

(or null string)

Readers

file-type.

Writers

(setf file-type).

Slot: truncated
Type

boolean

Readers

file-truncated.

Writers

(setf file-truncated).

Slot: language
Type

(or null string)

Readers

file-language.

Writers

(setf file-language).

Slot: content
Type

(or null string)

Readers

file-content.

Writers

(setf file-content).

Slot: old-name
Type

(or null string)

Readers

file-old-name.

Writers

This slot is read-only.

Structure: fork

Structure of Fork.

Package

cl-gists.fork.

Source

fork.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: user
Package

cl-gists.user.

Type

(or null cl-gists.user:user)

Readers

fork-user.

Writers

(setf fork-user).

Slot: url
Type

(or null string)

Readers

fork-url.

Writers

(setf fork-url).

Slot: id
Type

(or null string)

Readers

fork-id.

Writers

(setf fork-id).

Slot: created-at
Type

(or null local-time:timestamp)

Readers

fork-created-at.

Writers

(setf fork-created-at).

Slot: updated-at
Type

(or null local-time:timestamp)

Readers

fork-updated-at.

Writers

(setf fork-updated-at).

Structure: gist

Structure of Gist

Package

cl-gists.gist.

Source

gist.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: url
Type

(or null string)

Readers

gist-url.

Writers

(setf gist-url).

Slot: forks-url
Type

(or null string)

Readers

gist-forks-url.

Writers

(setf gist-forks-url).

Slot: commits-url
Type

(or null string)

Readers

gist-commits-url.

Writers

(setf gist-commits-url).

Slot: id
Type

(or null string)

Readers

gist-id.

Writers

(setf gist-id).

Slot: description
Type

(or null string)

Readers

gist-description.

Writers

(setf gist-description).

Slot: public
Type

boolean

Readers

gist-public.

Writers

(setf gist-public).

Slot: owner
Type

(or null cl-gists.user:user)

Readers

gist-owner.

Writers

(setf gist-owner).

Slot: fork-of
Type

(or null cl-gists.gist:gist)

Readers

gist-fork-of.

Writers

(setf gist-fork-of).

Slot: user
Package

cl-gists.user.

Readers

gist-user.

Writers

(setf gist-user).

Slot: files
Type

list

Readers

gist-files.

Writers

(setf gist-files).

Slot: comments
Type

(or null integer)

Readers

gist-comments.

Writers

(setf gist-comments).

Slot: comments-url
Type

(or null string)

Readers

gist-comments-url.

Writers

(setf gist-comments-url).

Slot: html-url
Type

(or null string)

Readers

gist-html-url.

Writers

(setf gist-html-url).

Slot: git-pull-url
Type

(or null string)

Readers

gist-git-pull-url.

Writers

(setf gist-git-pull-url).

Slot: git-push-url
Type

(or null string)

Readers

gist-git-push-url.

Writers

(setf gist-git-push-url).

Slot: created-at
Type

(or null local-time:timestamp)

Readers

gist-created-at.

Writers

(setf gist-created-at).

Slot: updated-at
Type

(or null local-time:timestamp)

Readers

gist-updated-at.

Writers

(setf gist-updated-at).

Slot: forks
Type

list

Readers

gist-forks.

Writers

(setf gist-forks).

Slot: history
Package

cl-gists.history.

Type

list

Readers

gist-history.

Writers

(setf gist-history).

Slot: truncated
Type

boolean

Readers

gist-truncated.

Writers

(setf gist-truncated).

Slot: node-id
Type

(or null string)

Readers

gist-node-id.

Writers

(setf gist-node-id).

Structure: history

Structure of History.

Package

cl-gists.history.

Source

history.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: url
Type

(or null string)

Readers

history-url.

Writers

(setf history-url).

Slot: version
Type

(or null string)

Readers

history-version.

Writers

(setf history-version).

Slot: user
Package

cl-gists.user.

Type

(or null cl-gists.user:user)

Readers

history-user.

Writers

(setf history-user).

Slot: deletions
Type

(or null integer)

Readers

history-deletions.

Writers

(setf history-deletions).

Slot: additions
Type

(or null integer)

Readers

history-additions.

Writers

(setf history-additions).

Slot: total
Type

(or null integer)

Readers

history-total.

Writers

(setf history-total).

Slot: committed-at
Type

(or null local-time:timestamp)

Readers

history-committed-at.

Writers

(setf history-committed-at).

Structure: user

Structure of User.

Package

cl-gists.user.

Source

user.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: login
Type

(or null string)

Readers

user-login.

Writers

(setf user-login).

Slot: id
Type

(or null integer)

Readers

user-id.

Writers

(setf user-id).

Slot: avatar-url
Type

(or null string)

Readers

user-avatar-url.

Writers

(setf user-avatar-url).

Slot: gravatar-id
Type

(or null string)

Readers

user-gravatar-id.

Writers

(setf user-gravatar-id).

Slot: url
Type

(or null string)

Readers

user-url.

Writers

(setf user-url).

Slot: html-url
Type

(or null string)

Readers

user-html-url.

Writers

(setf user-html-url).

Slot: followers-url
Type

(or null string)

Readers

user-followers-url.

Writers

(setf user-followers-url).

Slot: following-url
Type

(or null string)

Readers

user-following-url.

Writers

(setf user-following-url).

Slot: gists-url
Type

(or null string)

Readers

user-gists-url.

Writers

(setf user-gists-url).

Slot: starred-url
Type

(or null string)

Readers

user-starred-url.

Writers

(setf user-starred-url).

Slot: subscriptions-url
Type

(or null string)

Readers

user-subscriptions-url.

Writers

(setf user-subscriptions-url).

Slot: organizations-url
Type

(or null string)

Readers

user-organizations-url.

Writers

(setf user-organizations-url).

Slot: repos-url
Type

(or null string)

Readers

user-repos-url.

Writers

(setf user-repos-url).

Slot: events-url
Type

(or null string)

Readers

user-events-url.

Writers

(setf user-events-url).

Slot: received-events-url
Type

(or null string)

Readers

user-received-events-url.

Writers

(setf user-received-events-url).

Slot: type
Package

common-lisp.

Type

(or null string)

Readers

user-type.

Writers

(setf user-type).

Slot: site-admin
Type

boolean

Readers

user-site-admin.

Writers

(setf user-site-admin).

Slot: node-id
Type

(or null string)

Readers

user-node-id.

Writers

(setf user-node-id).


6.2 Internals


6.2.1 Special variables

Special Variable: *raw-keyword*
Package

cl-gists.util.

Source

util.lisp.

Special Variable: +api-base-uri+

GitHub API Base URI

Package

cl-gists.api.

Source

api.lisp.


6.2.2 Ordinary functions

Function: %make-fork (&key user url id created-at updated-at)
Package

cl-gists.fork.

Source

fork.lisp.

Function: %make-gist (&key url forks-url commits-url id description public owner fork-of user files comments comments-url html-url git-pull-url git-push-url created-at updated-at forks history truncated node-id)
Package

cl-gists.gist.

Source

gist.lisp.

Function: %make-history (&key url version user deletions additions total committed-at)
Package

cl-gists.history.

Source

history.lisp.

Function: check-credentials ()
Package

cl-gists.api.

Source

api.lisp.

Function: copy-file (instance)
Package

cl-gists.file.

Source

file.lisp.

Function: copy-fork (instance)
Package

cl-gists.fork.

Source

fork.lisp.

Function: copy-gist (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Function: copy-history (instance)
Package

cl-gists.history.

Source

history.lisp.

Function: copy-user (instance)
Package

cl-gists.user.

Source

user.lisp.

Function: file-p (object)
Package

cl-gists.file.

Source

file.lisp.

Function: fork-p (object)
Package

cl-gists.fork.

Source

fork.lisp.

Function: get-gist-id (id-or-gist)
Package

cl-gists.api.

Source

api.lisp.

Reader: gist-node-id (instance)
Writer: (setf gist-node-id) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

node-id.

Function: gist-p (object)
Package

cl-gists.gist.

Source

gist.lisp.

Reader: gist-truncated (instance)
Writer: (setf gist-truncated) (instance)
Package

cl-gists.gist.

Source

gist.lisp.

Target Slot

truncated.

Function: history-p (object)
Package

cl-gists.history.

Source

history.lisp.

Reader: user-gravatar-id (instance)
Writer: (setf user-gravatar-id) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

gravatar-id.

Reader: user-node-id (instance)
Writer: (setf user-node-id) (instance)
Package

cl-gists.user.

Source

user.lisp.

Target Slot

node-id.

Function: user-p (object)
Package

cl-gists.user.

Source

user.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
C   D   E   F   G   H   L   M   O   P   R   S   U  
Index Entry  Section

%
%make-fork: Private ordinary functions
%make-gist: Private ordinary functions
%make-history: Private ordinary functions

(
(setf file-content): Public ordinary functions
(setf file-language): Public ordinary functions
(setf file-name): Public ordinary functions
(setf file-raw-url): Public ordinary functions
(setf file-size): Public ordinary functions
(setf file-truncated): Public ordinary functions
(setf file-type): Public ordinary functions
(setf fork-created-at): Public ordinary functions
(setf fork-id): Public ordinary functions
(setf fork-updated-at): Public ordinary functions
(setf fork-url): Public ordinary functions
(setf fork-user): Public ordinary functions
(setf gist-comments): Public ordinary functions
(setf gist-comments-url): Public ordinary functions
(setf gist-commits-url): Public ordinary functions
(setf gist-created-at): Public ordinary functions
(setf gist-description): Public ordinary functions
(setf gist-files): Public ordinary functions
(setf gist-fork-of): Public ordinary functions
(setf gist-forks): Public ordinary functions
(setf gist-forks-url): Public ordinary functions
(setf gist-git-pull-url): Public ordinary functions
(setf gist-git-push-url): Public ordinary functions
(setf gist-history): Public ordinary functions
(setf gist-html-url): Public ordinary functions
(setf gist-id): Public ordinary functions
(setf gist-node-id): Private ordinary functions
(setf gist-owner): Public ordinary functions
(setf gist-public): Public ordinary functions
(setf gist-truncated): Private ordinary functions
(setf gist-updated-at): Public ordinary functions
(setf gist-url): Public ordinary functions
(setf gist-user): Public ordinary functions
(setf history-additions): Public ordinary functions
(setf history-committed-at): Public ordinary functions
(setf history-deletions): Public ordinary functions
(setf history-total): Public ordinary functions
(setf history-url): Public ordinary functions
(setf history-user): Public ordinary functions
(setf history-version): Public ordinary functions
(setf user-avatar-url): Public ordinary functions
(setf user-events-url): Public ordinary functions
(setf user-followers-url): Public ordinary functions
(setf user-following-url): Public ordinary functions
(setf user-gists-url): Public ordinary functions
(setf user-gravatar-id): Private ordinary functions
(setf user-html-url): Public ordinary functions
(setf user-id): Public ordinary functions
(setf user-login): Public ordinary functions
(setf user-node-id): Private ordinary functions
(setf user-organizations-url): Public ordinary functions
(setf user-received-events-url): Public ordinary functions
(setf user-repos-url): Public ordinary functions
(setf user-site-admin): Public ordinary functions
(setf user-starred-url): Public ordinary functions
(setf user-subscriptions-url): Public ordinary functions
(setf user-type): Public ordinary functions
(setf user-url): Public ordinary functions

C
check-credentials: Private ordinary functions
copy-file: Private ordinary functions
copy-fork: Private ordinary functions
copy-gist: Private ordinary functions
copy-history: Private ordinary functions
copy-user: Private ordinary functions
create-gist: Public ordinary functions

D
delete-gist: Public ordinary functions
delete-request: Public ordinary functions

E
edit-gist: Public ordinary functions

F
file-content: Public ordinary functions
file-language: Public ordinary functions
file-name: Public ordinary functions
file-old-name: Public ordinary functions
file-p: Private ordinary functions
file-raw-url: Public ordinary functions
file-size: Public ordinary functions
file-truncated: Public ordinary functions
file-type: Public ordinary functions
fork-created-at: Public ordinary functions
fork-gist: Public ordinary functions
fork-id: Public ordinary functions
fork-p: Private ordinary functions
fork-updated-at: Public ordinary functions
fork-url: Public ordinary functions
fork-user: Public ordinary functions
format-timestring-for-api: Public ordinary functions
Function, %make-fork: Private ordinary functions
Function, %make-gist: Private ordinary functions
Function, %make-history: Private ordinary functions
Function, (setf file-content): Public ordinary functions
Function, (setf file-language): Public ordinary functions
Function, (setf file-name): Public ordinary functions
Function, (setf file-raw-url): Public ordinary functions
Function, (setf file-size): Public ordinary functions
Function, (setf file-truncated): Public ordinary functions
Function, (setf file-type): Public ordinary functions
Function, (setf fork-created-at): Public ordinary functions
Function, (setf fork-id): Public ordinary functions
Function, (setf fork-updated-at): Public ordinary functions
Function, (setf fork-url): Public ordinary functions
Function, (setf fork-user): Public ordinary functions
Function, (setf gist-comments): Public ordinary functions
Function, (setf gist-comments-url): Public ordinary functions
Function, (setf gist-commits-url): Public ordinary functions
Function, (setf gist-created-at): Public ordinary functions
Function, (setf gist-description): Public ordinary functions
Function, (setf gist-files): Public ordinary functions
Function, (setf gist-fork-of): Public ordinary functions
Function, (setf gist-forks): Public ordinary functions
Function, (setf gist-forks-url): Public ordinary functions
Function, (setf gist-git-pull-url): Public ordinary functions
Function, (setf gist-git-push-url): Public ordinary functions
Function, (setf gist-history): Public ordinary functions
Function, (setf gist-html-url): Public ordinary functions
Function, (setf gist-id): Public ordinary functions
Function, (setf gist-node-id): Private ordinary functions
Function, (setf gist-owner): Public ordinary functions
Function, (setf gist-public): Public ordinary functions
Function, (setf gist-truncated): Private ordinary functions
Function, (setf gist-updated-at): Public ordinary functions
Function, (setf gist-url): Public ordinary functions
Function, (setf gist-user): Public ordinary functions
Function, (setf history-additions): Public ordinary functions
Function, (setf history-committed-at): Public ordinary functions
Function, (setf history-deletions): Public ordinary functions
Function, (setf history-total): Public ordinary functions
Function, (setf history-url): Public ordinary functions
Function, (setf history-user): Public ordinary functions
Function, (setf history-version): Public ordinary functions
Function, (setf user-avatar-url): Public ordinary functions
Function, (setf user-events-url): Public ordinary functions
Function, (setf user-followers-url): Public ordinary functions
Function, (setf user-following-url): Public ordinary functions
Function, (setf user-gists-url): Public ordinary functions
Function, (setf user-gravatar-id): Private ordinary functions
Function, (setf user-html-url): Public ordinary functions
Function, (setf user-id): Public ordinary functions
Function, (setf user-login): Public ordinary functions
Function, (setf user-node-id): Private ordinary functions
Function, (setf user-organizations-url): Public ordinary functions
Function, (setf user-received-events-url): Public ordinary functions
Function, (setf user-repos-url): Public ordinary functions
Function, (setf user-site-admin): Public ordinary functions
Function, (setf user-starred-url): Public ordinary functions
Function, (setf user-subscriptions-url): Public ordinary functions
Function, (setf user-type): Public ordinary functions
Function, (setf user-url): Public ordinary functions
Function, check-credentials: Private ordinary functions
Function, copy-file: Private ordinary functions
Function, copy-fork: Private ordinary functions
Function, copy-gist: Private ordinary functions
Function, copy-history: Private ordinary functions
Function, copy-user: Private ordinary functions
Function, create-gist: Public ordinary functions
Function, delete-gist: Public ordinary functions
Function, delete-request: Public ordinary functions
Function, edit-gist: Public ordinary functions
Function, file-content: Public ordinary functions
Function, file-language: Public ordinary functions
Function, file-name: Public ordinary functions
Function, file-old-name: Public ordinary functions
Function, file-p: Private ordinary functions
Function, file-raw-url: Public ordinary functions
Function, file-size: Public ordinary functions
Function, file-truncated: Public ordinary functions
Function, file-type: Public ordinary functions
Function, fork-created-at: Public ordinary functions
Function, fork-gist: Public ordinary functions
Function, fork-id: Public ordinary functions
Function, fork-p: Private ordinary functions
Function, fork-updated-at: Public ordinary functions
Function, fork-url: Public ordinary functions
Function, fork-user: Public ordinary functions
Function, format-timestring-for-api: Public ordinary functions
Function, get-gist: Public ordinary functions
Function, get-gist-id: Private ordinary functions
Function, get-request: Public ordinary functions
Function, gist-comments: Public ordinary functions
Function, gist-comments-url: Public ordinary functions
Function, gist-commits-url: Public ordinary functions
Function, gist-created-at: Public ordinary functions
Function, gist-description: Public ordinary functions
Function, gist-files: Public ordinary functions
Function, gist-fork-of: Public ordinary functions
Function, gist-forks: Public ordinary functions
Function, gist-forks-url: Public ordinary functions
Function, gist-git-pull-url: Public ordinary functions
Function, gist-git-push-url: Public ordinary functions
Function, gist-history: Public ordinary functions
Function, gist-html-url: Public ordinary functions
Function, gist-id: Public ordinary functions
Function, gist-node-id: Private ordinary functions
Function, gist-owner: Public ordinary functions
Function, gist-p: Private ordinary functions
Function, gist-public: Public ordinary functions
Function, gist-starred-p: Public ordinary functions
Function, gist-truncated: Private ordinary functions
Function, gist-updated-at: Public ordinary functions
Function, gist-url: Public ordinary functions
Function, gist-user: Public ordinary functions
Function, history-additions: Public ordinary functions
Function, history-committed-at: Public ordinary functions
Function, history-deletions: Public ordinary functions
Function, history-p: Private ordinary functions
Function, history-total: Public ordinary functions
Function, history-url: Public ordinary functions
Function, history-user: Public ordinary functions
Function, history-version: Public ordinary functions
Function, list-gist-commits: Public ordinary functions
Function, list-gist-forks: Public ordinary functions
Function, list-gists: Public ordinary functions
Function, make-file: Public ordinary functions
Function, make-files: Public ordinary functions
Function, make-fork: Public ordinary functions
Function, make-forks: Public ordinary functions
Function, make-gist: Public ordinary functions
Function, make-gists: Public ordinary functions
Function, make-histories: Public ordinary functions
Function, make-history: Public ordinary functions
Function, make-user: Public ordinary functions
Function, parse-json: Public ordinary functions
Function, patch-request: Public ordinary functions
Function, post-request: Public ordinary functions
Function, put-request: Public ordinary functions
Function, request: Public ordinary functions
Function, star-gist: Public ordinary functions
Function, unstar-gist: Public ordinary functions
Function, user-avatar-url: Public ordinary functions
Function, user-events-url: Public ordinary functions
Function, user-followers-url: Public ordinary functions
Function, user-following-url: Public ordinary functions
Function, user-gists-url: Public ordinary functions
Function, user-gravatar-id: Private ordinary functions
Function, user-html-url: Public ordinary functions
Function, user-id: Public ordinary functions
Function, user-login: Public ordinary functions
Function, user-node-id: Private ordinary functions
Function, user-organizations-url: Public ordinary functions
Function, user-p: Private ordinary functions
Function, user-received-events-url: Public ordinary functions
Function, user-repos-url: Public ordinary functions
Function, user-site-admin: Public ordinary functions
Function, user-starred-url: Public ordinary functions
Function, user-subscriptions-url: Public ordinary functions
Function, user-type: Public ordinary functions
Function, user-url: Public ordinary functions

G
Generic Function, oauth-token: Public generic functions
Generic Function, password: Public generic functions
Generic Function, username: Public generic functions
get-gist: Public ordinary functions
get-gist-id: Private ordinary functions
get-request: Public ordinary functions
gist-comments: Public ordinary functions
gist-comments-url: Public ordinary functions
gist-commits-url: Public ordinary functions
gist-created-at: Public ordinary functions
gist-description: Public ordinary functions
gist-files: Public ordinary functions
gist-fork-of: Public ordinary functions
gist-forks: Public ordinary functions
gist-forks-url: Public ordinary functions
gist-git-pull-url: Public ordinary functions
gist-git-push-url: Public ordinary functions
gist-history: Public ordinary functions
gist-html-url: Public ordinary functions
gist-id: Public ordinary functions
gist-node-id: Private ordinary functions
gist-owner: Public ordinary functions
gist-p: Private ordinary functions
gist-public: Public ordinary functions
gist-starred-p: Public ordinary functions
gist-truncated: Private ordinary functions
gist-updated-at: Public ordinary functions
gist-url: Public ordinary functions
gist-user: Public ordinary functions

H
history-additions: Public ordinary functions
history-committed-at: Public ordinary functions
history-deletions: Public ordinary functions
history-p: Private ordinary functions
history-total: Public ordinary functions
history-url: Public ordinary functions
history-user: Public ordinary functions
history-version: Public ordinary functions

L
list-gist-commits: Public ordinary functions
list-gist-forks: Public ordinary functions
list-gists: Public ordinary functions

M
make-file: Public ordinary functions
make-files: Public ordinary functions
make-fork: Public ordinary functions
make-forks: Public ordinary functions
make-gist: Public ordinary functions
make-gists: Public ordinary functions
make-histories: Public ordinary functions
make-history: Public ordinary functions
make-user: Public ordinary functions
Method, oauth-token: Public generic functions
Method, password: Public generic functions
Method, username: Public generic functions

O
oauth-token: Public generic functions
oauth-token: Public generic functions

P
parse-json: Public ordinary functions
password: Public generic functions
password: Public generic functions
patch-request: Public ordinary functions
post-request: Public ordinary functions
put-request: Public ordinary functions

R
request: Public ordinary functions

S
star-gist: Public ordinary functions

U
unstar-gist: Public ordinary functions
user-avatar-url: Public ordinary functions
user-events-url: Public ordinary functions
user-followers-url: Public ordinary functions
user-following-url: Public ordinary functions
user-gists-url: Public ordinary functions
user-gravatar-id: Private ordinary functions
user-html-url: Public ordinary functions
user-id: Public ordinary functions
user-login: Public ordinary functions
user-node-id: Private ordinary functions
user-organizations-url: Public ordinary functions
user-p: Private ordinary functions
user-received-events-url: Public ordinary functions
user-repos-url: Public ordinary functions
user-site-admin: Public ordinary functions
user-starred-url: Public ordinary functions
user-subscriptions-url: Public ordinary functions
user-type: Public ordinary functions
user-url: Public ordinary functions
username: Public generic functions
username: Public generic functions


A.3 Variables

Jump to:   *   +  
A   C   D   E   F   G   H   I   L   N   O   P   R   S   T   U   V  
Index Entry  Section

*
*credentials*: Public special variables
*github-oauth-token-env-var*: Public special variables
*github-password-env-var*: Public special variables
*github-username-env-var*: Public special variables
*raw-keyword*: Private special variables

+
+api-base-uri+: Private special variables

A
additions: Public structures
avatar-url: Public structures

C
comments: Public structures
comments-url: Public structures
commits-url: Public structures
committed-at: Public structures
content: Public structures
created-at: Public structures
created-at: Public structures

D
deletions: Public structures
description: Public structures

E
events-url: Public structures

F
files: Public structures
followers-url: Public structures
following-url: Public structures
fork-of: Public structures
forks: Public structures
forks-url: Public structures

G
gists-url: Public structures
git-pull-url: Public structures
git-push-url: Public structures
gravatar-id: Public structures

H
history: Public structures
html-url: Public structures
html-url: Public structures

I
id: Public structures
id: Public structures
id: Public structures

L
language: Public structures
login: Public structures

N
name: Public structures
node-id: Public structures
node-id: Public structures

O
old-name: Public structures
organizations-url: Public structures
owner: Public structures

P
public: Public structures

R
raw-url: Public structures
received-events-url: Public structures
repos-url: Public structures

S
site-admin: Public structures
size: Public structures
Slot, additions: Public structures
Slot, avatar-url: Public structures
Slot, comments: Public structures
Slot, comments-url: Public structures
Slot, commits-url: Public structures
Slot, committed-at: Public structures
Slot, content: Public structures
Slot, created-at: Public structures
Slot, created-at: Public structures
Slot, deletions: Public structures
Slot, description: Public structures
Slot, events-url: Public structures
Slot, files: Public structures
Slot, followers-url: Public structures
Slot, following-url: Public structures
Slot, fork-of: Public structures
Slot, forks: Public structures
Slot, forks-url: Public structures
Slot, gists-url: Public structures
Slot, git-pull-url: Public structures
Slot, git-push-url: Public structures
Slot, gravatar-id: Public structures
Slot, history: Public structures
Slot, html-url: Public structures
Slot, html-url: Public structures
Slot, id: Public structures
Slot, id: Public structures
Slot, id: Public structures
Slot, language: Public structures
Slot, login: Public structures
Slot, name: Public structures
Slot, node-id: Public structures
Slot, node-id: Public structures
Slot, old-name: Public structures
Slot, organizations-url: Public structures
Slot, owner: Public structures
Slot, public: Public structures
Slot, raw-url: Public structures
Slot, received-events-url: Public structures
Slot, repos-url: Public structures
Slot, site-admin: Public structures
Slot, size: Public structures
Slot, starred-url: Public structures
Slot, subscriptions-url: Public structures
Slot, total: Public structures
Slot, truncated: Public structures
Slot, truncated: Public structures
Slot, type: Public structures
Slot, type: Public structures
Slot, updated-at: Public structures
Slot, updated-at: Public structures
Slot, url: Public structures
Slot, url: Public structures
Slot, url: Public structures
Slot, url: Public structures
Slot, user: Public structures
Slot, user: Public structures
Slot, user: Public structures
Slot, version: Public structures
Special Variable, *credentials*: Public special variables
Special Variable, *github-oauth-token-env-var*: Public special variables
Special Variable, *github-password-env-var*: Public special variables
Special Variable, *github-username-env-var*: Public special variables
Special Variable, *raw-keyword*: Private special variables
Special Variable, +api-base-uri+: Private special variables
starred-url: Public structures
subscriptions-url: Public structures

T
total: Public structures
truncated: Public structures
truncated: Public structures
type: Public structures
type: Public structures

U
updated-at: Public structures
updated-at: Public structures
url: Public structures
url: Public structures
url: Public structures
url: Public structures
user: Public structures
user: Public structures
user: Public structures

V
version: Public structures


A.4 Data types

Jump to:   A   C   F   G   H   M   P   S   U  
Index Entry  Section

A
api.lisp: The cl-gists/src/api․lisp file

C
cl-gists: The cl-gists system
cl-gists: The cl-gists package
cl-gists.api: The cl-gists․api package
cl-gists.asd: The cl-gists/cl-gists․asd file
cl-gists.file: The cl-gists․file package
cl-gists.fork: The cl-gists․fork package
cl-gists.gist: The cl-gists․gist package
cl-gists.history: The cl-gists․history package
cl-gists.user: The cl-gists․user package
cl-gists.util: The cl-gists․util package

F
file: Public structures
File, api.lisp: The cl-gists/src/api․lisp file
File, cl-gists.asd: The cl-gists/cl-gists․asd file
File, file.lisp: The cl-gists/src/file․lisp file
File, fork.lisp: The cl-gists/src/fork․lisp file
File, gist.lisp: The cl-gists/src/gist․lisp file
File, history.lisp: The cl-gists/src/history․lisp file
File, pkgdcl.lisp: The cl-gists/src/pkgdcl․lisp file
File, user.lisp: The cl-gists/src/user․lisp file
File, util.lisp: The cl-gists/src/util․lisp file
file.lisp: The cl-gists/src/file․lisp file
fork: Public structures
fork.lisp: The cl-gists/src/fork․lisp file

G
gist: Public structures
gist.lisp: The cl-gists/src/gist․lisp file

H
history: Public structures
history.lisp: The cl-gists/src/history․lisp file

M
Module, src: The cl-gists/src module

P
Package, cl-gists: The cl-gists package
Package, cl-gists.api: The cl-gists․api package
Package, cl-gists.file: The cl-gists․file package
Package, cl-gists.fork: The cl-gists․fork package
Package, cl-gists.gist: The cl-gists․gist package
Package, cl-gists.history: The cl-gists․history package
Package, cl-gists.user: The cl-gists․user package
Package, cl-gists.util: The cl-gists․util package
pkgdcl.lisp: The cl-gists/src/pkgdcl․lisp file

S
src: The cl-gists/src module
Structure, file: Public structures
Structure, fork: Public structures
Structure, gist: Public structures
Structure, history: Public structures
Structure, user: Public structures
System, cl-gists: The cl-gists system

U
user: Public structures
user.lisp: The cl-gists/src/user․lisp file
util.lisp: The cl-gists/src/util․lisp file