/mod.ts | willow_utils@0.8.0

import * as willowUtils from "https://deno.land/x/willow_utils@0.8.0/mod.ts";

Classes

GrowingBytes

An array of growing bytes which can be awaited upon and pruned.

Variables

v ANY_SUBSPACE
v OPEN_END	Represents an open value for a range ending.

Functions

f areaIsIncluded	Return whether an area is fully included by another area.
f areaTo3dRange	Convert an `Area` to a `Range3d`.
f bigintToBytes
f commonPrefix	Return the prefix shared by two `Path`s.
f compactWidth	Returns the number of octets needed to store a number, along the lines of 8-bit, 16-bit, 32-bit, or 64-bit unsigned integers.
f decodeAreaInArea	Decode an `Area` relative to a known outer `Area`.
f decodeCompactWidth	Decode a variable width integer. Uses the bytelength of the passed encoding to determine the compact width.
f decodeEntry	Decode bytes to an `Entry`.
f decodePath	Decodes a path.
f decodePathRelative	Decodes a `Path` relative to another `Path`.
f decodeRange3dRelative
f decodeStreamAreaInArea
f decodeStreamEntryInNamespaceArea
f decodeStreamEntryRelativeEntry
f decodeStreamEntryRelativeRange3d
f decodeStreamPath	Decodes an encoded path (which is streaming in).
f decodeStreamPathRelative
f decodeStreamRange3dRelative
f decodeUintMax32	Decodes an UintMax unsigned integer,
f defaultEntry
f defaultRange3d
f encodeAreaInArea	Encode an `Area` relative to known outer `Area`.
f encodeAreaInAreaLength
f encodeCompactWidth	Encodes an integer using the smallest number of bytes possible.
f encodedPathLength	Encodes the length of a `Path`.
f encodedPathRelativeLength
f encodeEntry	Encode an `Entry`.
f encodeEntryInNamespaceArea
f encodeEntryRelativeEntry
f encodeEntryRelativeRange3d
f encodePath	Encodes a path.
f encodePathRelative	Encodes a `Path` relative to another `Path`.
f encodeRange3dRelative
f encodeUintMax32	Encodes a number as a UintMax, with Max being the maximum number of octets needed to represent the unsigned integer
f entryPosition	Returns the `Position3d` of an `Entry`.
f fullArea
f intersectArea	Return the intersection of two areas, for which there may be none.
f intersectRange	Returns the intersection of two ranges, of which there may be none.
f intersectRange3d
f isEqualRangeValue
f isIncluded3d	Returns whether a `Position3d` is included by a given `Range`.
f isIncludedArea	Return whether a 3d position is included by an `Area`.
f isIncludedRange	Returns whether a `Value` is included by a given `Range`.
f isPathPrefixed	Returns whether a path is prefixed by another path.
f isSubspaceIncludedInArea	Return whether a subspace ID is included by an `Area`.
f isValidPath	Returns whether a `Path` does not exceed the limits given by a `PathScheme`.
f isValidRange
f isValidRange3d
f max32Width	Returns the maximum number of octets needed to store an unsigned integer.
f orderBytes	A total order over bytestrings.
f orderPath	A total order over `Path`.
f orderRangePair	Order a given pair of ranges by their type. Useful for functions using boolean logic based on the different combinations of range types.
f orderTimestamp	A total order over `BigInt`.
f prefixesOf	Return all prefixes of a given path (which included the path itself), in order of path length.
f rangeIsIncluded	Returns whether a range is fully included by another range.
f subspaceArea
f successorBytesFixedWidth	Return the succeeding bytestring of the given bytestring without increasing that bytestring's length.
f successorPath	Returns the successor to a path given a `Path` and `PathScheme`.
f successorPrefix	Return a successor to a prefix, that is, the next element that is not a prefix of the given path.

Type Aliases

T Area	A grouping of Entries.
T AreaOfInterest	A grouping of Entries that are among the newest in some store.
T EncodingScheme
T Entry	The metadata for storing a payload.
T KeypairEncodingScheme	A scheme for encoding public keys and the signatures they produce.
T KeypairScheme	A scheme for signing with a keypair, and encoding the associated public keys and signatures.
T Path	A Path is a sequence of bytestrings which `Entry`s are written to.
T PathScheme	A set of limits for `Path`s.
T Position3d	A position in a space with dimensions of time, path, and subspace.
T PrivyEncodingScheme
T Range	A closed or open range of values.
T Range3d	A three-dimensional with dimension of time, path, and subspace.
T SignatureScheme	A scheme for signing and verifying data using key pairs.
T StreamDecoder
T SuccessorFn	A function which returns the succeeding value for a given value of a set.
T TotalOrder	Defines a total order over a given set.