3 lines
18 KiB
HTML
3 lines
18 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
|
"">
|
|
<html><head><meta charset="UTF-8" /><title>Dog-and-duck 0.1.0</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Dog-and-duck</span> <span class="project-version">0.1.0</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="Desiderata.html"><div class="inner"><span>Desiderata</span></div></a></li><li class="depth-1 "><a href="Using_ActivityPub.html"><div class="inner"><span>Using ActivityPub</span></div></a></li><li class="depth-1 "><a href="Validation_Faults.html"><div class="inner"><span>Validation Faults in ActivityPub documents</span></div></a></li><li class="depth-1 "><a href="intro.html"><div class="inner"><span>The Old Dog and Duck</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>dog-and-duck</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>quack</span></div></div></li><li class="depth-3 branch"><a href="dog-and-duck.quack.cli.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cli</span></div></a></li><li class="depth-3"><a href="dog-and-duck.quack.picky.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>picky</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.collections.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>collections</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.constants.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>constants</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.control-variables.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>control-variables</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.distribution.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>distribution</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.objects.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>objects</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.scratch.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>scratch</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.time.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>time</span></div></a></li><li class="depth-4"><a href="dog-and-duck.quack.picky.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-3"><a href="dog-and-duck.quack.quack.html"><div class="inner"><span class="tree" style="top: -269px;"><span class="top" style="height: 278px;"></span><span class="bottom"></span></span><span>quack</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -362px;"><span class="top" style="height: 371px;"></span><span class="bottom"></span></span><span>scratch</span></div></div></li><li class="depth-3 branch"><a href="dog-and-duck.scratch.parser.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>parser</span></div></a></li><li class="depth-3"><a href="dog-and-duck.scratch.scratch.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>scratch</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>utils</span></div></div></li><li class="depth-3"><a href="dog-and-duck.utils.process.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>process</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Dog-and-duck</span> <span class="project-version">0.1.0</span></span></h1><h5 class="license">Released under the <a href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html">GPL-2.0-or-later</a></h5><div class="doc"><p>A playground for hacking ActivityPub stuff.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[dog-and-duck "0.1.0"]</pre><h2>Topics</h2><ul class="topics"><li><a href="Desiderata.html">Desiderata</a></li><li><a href="Using_ActivityPub.html">Using ActivityPub</a></li><li><a href="Validation_Faults.html">Validation Faults in ActivityPub documents</a></li><li><a href="intro.html">The Old Dog and Duck</a></li></ul><h2>Namespaces</h2><div class="namespace"><h3><a href="dog-and-duck.quack.cli.html">dog-and-duck.quack.cli</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.quack.cli.html#var--main">-main</a> </li><li> <a href="dog-and-duck.quack.cli.html#var-cli-options">cli-options</a> </li><li> <a href="dog-and-duck.quack.cli.html#var-html-fault-row">html-fault-row</a> </li><li> <a href="dog-and-duck.quack.cli.html#var-html-header-row">html-header-row</a> </li><li> <a href="dog-and-duck.quack.cli.html#var-output">output</a> </li><li> <a href="dog-and-duck.quack.cli.html#var-output-csv">output-csv</a> </li><li> <a href="dog-and-duck.quack.cli.html#var-output-html">output-html</a> </li><li> <a href="dog-and-duck.quack.cli.html#var-stylesheet-url">stylesheet-url</a> </li><li> <a href="dog-and-duck.quack.cli.html#var-validate">validate</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.quack.picky.html">dog-and-duck.quack.picky</a></h3><div class="doc"><div class="markdown"><p>Fault-finder for ActivityPub documents. </p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.quack.picky.html#var-accept-required-properties">accept-required-properties</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-activity-faults">activity-faults</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-activity-required-properties">activity-required-properties</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-activity-type-faults">activity-type-faults</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-actor-faults">actor-faults</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-base-activity-required-properties">base-activity-required-properties</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-collection-faults">collection-faults</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-intransitive-activity-required-properties">intransitive-activity-required-properties</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-link-faults">link-faults</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-persistent-object-faults">persistent-object-faults</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-uri-or-fault">uri-or-fault</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.quack.picky.collections.html">dog-and-duck.quack.picky.collections</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.quack.picky.collections.html#var-collection-page-faults">collection-page-faults</a> </li><li> <a href="dog-and-duck.quack.picky.collections.html#var-paged-collection-faults">paged-collection-faults</a> </li><li> <a href="dog-and-duck.quack.picky.collections.html#var-simple-collection-faults">simple-collection-faults</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.quack.picky.constants.html">dog-and-duck.quack.picky.constants</a></h3><div class="doc"><div class="markdown"><p>Constants supporting the picky validator.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.quack.picky.constants.html#var-activity-types">activity-types</a> </li><li> <a href="dog-and-duck.quack.picky.constants.html#var-activitystreams-context-uri">activitystreams-context-uri</a> </li><li> <a href="dog-and-duck.quack.picky.constants.html#var-actor-types">actor-types</a> </li><li> <a href="dog-and-duck.quack.picky.constants.html#var-context-key">context-key</a> </li><li> <a href="dog-and-duck.quack.picky.constants.html#var-implicit-noun-types">implicit-noun-types</a> </li><li> <a href="dog-and-duck.quack.picky.constants.html#var-noun-types">noun-types</a> </li><li> <a href="dog-and-duck.quack.picky.constants.html#var-re-rfc5646">re-rfc5646</a> </li><li> <a href="dog-and-duck.quack.picky.constants.html#var-severity">severity</a> </li><li> <a href="dog-and-duck.quack.picky.constants.html#var-severity-filters">severity-filters</a> </li><li> <a href="dog-and-duck.quack.picky.constants.html#var-validation-fault-context-uri">validation-fault-context-uri</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.quack.picky.control-variables.html">dog-and-duck.quack.picky.control-variables</a></h3><div class="doc"><div class="markdown"><p>Control variables for the picky validator.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.quack.picky.control-variables.html#var-*reify-refs*">*reify-refs*</a> </li><li> <a href="dog-and-duck.quack.picky.control-variables.html#var-*reject-severity*">*reject-severity*</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.quack.picky.distribution.html">dog-and-duck.quack.picky.distribution</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.quack.picky.distribution.html#var-distribution">distribution</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.quack.picky.objects.html">dog-and-duck.quack.picky.objects</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.quack.picky.objects.html#var-check-property">check-property</a> </li><li> <a href="dog-and-duck.quack.picky.objects.html#var-check-property-required">check-property-required</a> </li><li> <a href="dog-and-duck.quack.picky.objects.html#var-check-property-valid">check-property-valid</a> </li><li> <a href="dog-and-duck.quack.picky.objects.html#var-coll-object-reference-or-fault">coll-object-reference-or-fault</a> </li><li> <a href="dog-and-duck.quack.picky.objects.html#var-maybe-reify">maybe-reify</a> </li><li> <a href="dog-and-duck.quack.picky.objects.html#var-maybe-reify-or-faults">maybe-reify-or-faults</a> </li><li> <a href="dog-and-duck.quack.picky.objects.html#var-object-expected-properties">object-expected-properties</a> </li><li> <a href="dog-and-duck.quack.picky.objects.html#var-object-faults">object-faults</a> </li><li> <a href="dog-and-duck.quack.picky.objects.html#var-object-reference-or-faults">object-reference-or-faults</a> </li><li> <a href="dog-and-duck.quack.picky.objects.html#var-properties-faults">properties-faults</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.quack.picky.scratch.html">dog-and-duck.quack.picky.scratch</a></h3><div class="doc"><div class="markdown"><p>Development scratchpad</p></div></div><div class="index"><p>Public variables and functions:</p><ul></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.quack.picky.time.html">dog-and-duck.quack.picky.time</a></h3><div class="doc"><div class="markdown"><p>Time, gentleman, please! Recognising and validating date time values.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.quack.picky.time.html#var-date-time-property-or-fault">date-time-property-or-fault</a> </li><li> <a href="dog-and-duck.quack.picky.time.html#var-xsd-date-time.3F">xsd-date-time?</a> </li><li> <a href="dog-and-duck.quack.picky.time.html#var-xsd-duration.3F">xsd-duration?</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.quack.picky.utils.html">dog-and-duck.quack.picky.utils</a></h3><div class="doc"><div class="markdown"><p>Utility functions supporting the picky validator</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.quack.picky.utils.html#var-activity-type.3F">activity-type?</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-actor-type.3F">actor-type?</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-any-or-faults">any-or-faults</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-concat-non-empty">concat-non-empty</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-cond-make-fault-object">cond-make-fault-object</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-context.3F">context?</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-filter-severity">filter-severity</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-has-activity-type.3F">has-activity-type?</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-has-actor-type.3F">has-actor-type?</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-has-context.3F">has-context?</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-has-type-or-fault">has-type-or-fault</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-has-type.3F">has-type?</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-link-or-uri.3F">link-or-uri?</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-make-fault-object">make-fault-object</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-nil-if-empty">nil-if-empty</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-object-or-uri.3F">object-or-uri?</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-string-or-fault">string-or-fault</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-truthy.3F">truthy?</a> </li><li> <a href="dog-and-duck.quack.picky.utils.html#var-xsd-non-negative-integer.3F">xsd-non-negative-integer?</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.quack.quack.html">dog-and-duck.quack.quack</a></h3><div class="doc"><div class="markdown"><p>Validator for ActivityPub objects: if it walks like a duck, and it quacks like a duck…</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.quack.quack.html#var-activity.3F">activity?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-actor-or-uri.3F">actor-or-uri?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-actor.3F">actor?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-collection-page.3F">collection-page?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-collection.3F">collection?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-link-or-uri.3F">link-or-uri?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-link.3F">link?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-object.3F">object?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-ordered-collection-page.3F">ordered-collection-page?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-ordered-collection.3F">ordered-collection?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-persistent-object.3F">persistent-object?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-unordered-collection.3F">unordered-collection?</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.scratch.parser.html">dog-and-duck.scratch.parser</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.scratch.parser.html#var-clean">clean</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.scratch.scratch.html">dog-and-duck.scratch.scratch</a></h3><div class="doc"><div class="markdown"><p>Scratchpad where I try to understand how to do this stuff.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.scratch.scratch.html#var-account-handle">account-handle</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.utils.process.html">dog-and-duck.utils.process</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.utils.process.html#var-get-hostname">get-hostname</a> </li><li> <a href="dog-and-duck.utils.process.html#var-get-pid">get-pid</a> </li></ul></div></div></div></body></html> |