ranke

package module

Go to main page

Versions in this module

v0

v0.34.0

Sep 16, 2026

Changes in this version

+ var ErrEnvelopeScheme = errors.New(...)

+ func LoadPublicKeyPEM(path string) (crypto.PublicKey, error)

+ func ParsePrivateKeyPEM(pemBytes []byte, opts ...KeyOption) (crypto.Signer, error)

+ func ParsePublicKeyPEM(pemBytes []byte) (crypto.PublicKey, error)

v0.34.0-rc.1

Sep 16, 2026

v0.33.1

Sep 10, 2026

Changes in this version

+ var ErrContributorUnresolved = errors.New("ranke.verify: contributor claim unresolved")

+ var ErrHeightMismatch = errors.New("ranke.verify: claim height ≠ 1 + max(reference heights)")

+ var ErrKeyWindowField = errors.New("ranke.verify: contributor key validity bound is not RFC 3339")

+ var ErrRefsBranchTable = errors.New("ranke.verify: claim references a branch table")

+ var ErrUnexplainedGap = errors.New(...)

type Failure

+ func (f Failure) Error() string

+ func (f Failure) Unwrap() error

v0.33.0

Sep 10, 2026

Changes in this version

type ClaimBuilder

+ func (b ClaimBuilder) WithHeightResolver(ctx context.Context, resolve HeightResolver) ClaimBuilder

+ type HeightResolver func(ctx context.Context, refs []Id) (uint64, error)

+ func FixedHeight(h uint64) HeightResolver

+ func HeightsFrom(claims ...Claim) HeightResolver

+ func HeightsIn(u Universe) HeightResolver

v0.32.0

Sep 10, 2026

Changes in this version

+ var ErrKeyEncrypted = errors.New(...)

+ var ErrKeyFormat = errors.New("ranke: the key is not a PKCS#8 PEM (openssl pkcs8 -topk8 converts one)")

+ func IsEncryptedKey(pemBytes []byte) bool

+ type KeyOption func(*keyConfig)

+ func WithPassphrase(pass []byte) KeyOption

+ func WithPassphraseFrom(fn func() ([]byte, error)) KeyOption

v0.31.0

Sep 10, 2026

Changes in this version

+ func ParseEd25519PrivateKeyPEM(pemBytes []byte) (ed25519.PrivateKey, error)

+ func ParseEd25519PublicKeyPEM(pemBytes []byte) (ed25519.PublicKey, error)

type Keypair

+ func ParseKeypair(pemBytes []byte) (Keypair, error)

v0.30.1

Sep 10, 2026

v0.30.0

Sep 10, 2026

Changes in this version

+ var ErrBranchName = errors.New("ranke: a branch name is at most 128 bytes over [a-z0-9_] with no leading _")

+ func ValidateBranchName(name string) error

v0.29.0

Sep 9, 2026

Changes in this version

+ var ErrSequencerGenesis = errors.New("ranke.Sequencer: the archive awaits its first contributor (Found)")

type Sequencer

+ Found func(ctx context.Context, pubkey []byte) (Claim, error)

+ InGenesis func() bool

v0.28.0

Sep 2, 2026

Changes in this version

+ var ErrQueryTimeOperand = errors.New(...)

+ func FormatTimestamp(t time.Time) string

+ func MintSeed() ([]byte, error)

+ type BookmarkLocator struct

+ func At(id Id) BookmarkLocator

+ func Seed(s []byte) BookmarkLocator

+ func (l BookmarkLocator) Open(ctx context.Context, u Universe) (*Bookmarks, error)

type BookmarkStore

+ func UnsupportedBookmarks() BookmarkStore

type Capabilities

+ Bookmarks bool

+ type SpineItem struct

+ func NewSpineItem(id Id, revision int, height int, timestamp time.Time) SpineItem

+ func SpliceSpine(existing, tagged []SpineItem) []SpineItem

+ func (h SpineItem) GetHeight() int

+ func (h SpineItem) GetId() Id

+ func (h SpineItem) GetRevision() int

+ func (h SpineItem) GetTimestamp() time.Time

type Universe

+ Bookmarks func() BookmarkStore

v0.27.0

Sep 2, 2026

Changes in this version

+ var ErrArchiveFirstTableHeight = errors.New(...)

+ func CheckBookmarkHead(ctx context.Context, u Universe, bm Bookmark) error

+ func SignBookmark(self Contributor, index uint64, seed []byte, head Id) ([]byte, error)

+ type Bookmark struct

+ func DecodeBookmark(raw []byte) (Bookmark, error)

+ func NewBookmark(index uint64, seed []byte, head, signer Id) Bookmark

+ func VerifyBookmark(ctx context.Context, u Universe, slot Id, raw []byte) (Bookmark, error)

+ func (b Bookmark) Head() Id

+ func (b Bookmark) Index() uint64

+ func (b Bookmark) Seed() []byte

+ func (b Bookmark) Signer() Id

+ func (b Bookmark) Slot() (Id, error)

+ type BookmarkStore interface

+ Get func(ctx context.Context, key Id) ([]byte, error)

+ Put func(ctx context.Context, key Id, record []byte) error

+ func NewMemoryBookmarks() BookmarkStore

+ type Bookmarks struct

+ func NewBookmarks(hist BookmarkStore, u Universe, seed []byte) *Bookmarks

+ func OpenBookmarks(ctx context.Context, hist BookmarkStore, u Universe, id Id) (*Bookmarks, error)

+ func (b *Bookmarks) Append(ctx context.Context, self Contributor, head Id) (Bookmark, error)

+ func (b *Bookmarks) BookmarkId() Id

+ func (b *Bookmarks) GetAtIndex(ctx context.Context, i int) (Bookmark, error)

+ func (b *Bookmarks) GetBulk(ctx context.Context, from, toExcluding int) ([]Bookmark, error)

+ func (b *Bookmarks) Latest(ctx context.Context) (Bookmark, error)

+ func (b *Bookmarks) Len(ctx context.Context) (int, error)

+ func (b *Bookmarks) Seed() []byte

+ func (b *Bookmarks) Verify(ctx context.Context) error

type Id

+ func IdSeq(i uint64, s []byte) (Id, error)

type Sequencer

+ BookmarkId func() Id

v0.27.0-rc.2

Sep 2, 2026

v0.27.0-rc.1

Sep 2, 2026

v0.26.0

Aug 28, 2026

Changes in this version

+ const ArchiveTagKey

+ const BranchArchive

+ const BranchUniverse

+ const EdgeTypeBranch

+ const EdgeTypeBranches

+ const EdgeTypeContributor

+ const EdgeTypeDelete

+ const EdgeTypeDiff

+ const EdgeTypeExpiry

+ const EdgeTypeHead

+ const EdgeTypePrune

+ const Encoding3GP

+ const Encoding7Z

+ const EncodingAAC

+ const EncodingAPNG

+ const EncodingAVI

+ const EncodingAVIF

+ const EncodingBMP

+ const EncodingBzip2

+ const EncodingCSS

+ const EncodingCSV

+ const EncodingCalendar

+ const EncodingDOCX

+ const EncodingEPUB

+ const EncodingGIF

+ const EncodingGZIP

+ const EncodingHTML

+ const EncodingICO

+ const EncodingJAR

+ const EncodingJPEG

+ const EncodingJSON

+ const EncodingJSONLD

+ const EncodingJavaScript

+ const EncodingMIDI

+ const EncodingMP2T

+ const EncodingMP3

+ const EncodingMP4

+ const EncodingMPEG

+ const EncodingMSExcel

+ const EncodingMSPowerPoint

+ const EncodingMSWord

+ const EncodingMarkdown

+ const EncodingODP

+ const EncodingODS

+ const EncodingODT

+ const EncodingOTF

+ const EncodingOctetStream

+ const EncodingOggAudio

+ const EncodingOggVideo

+ const EncodingPDF

+ const EncodingPNG

+ const EncodingPPTX

+ const EncodingPlain

+ const EncodingRAR

+ const EncodingRTF

+ const EncodingSVG

+ const EncodingTAR

+ const EncodingTIFF

+ const EncodingTTF

+ const EncodingWAV

+ const EncodingWOFF

+ const EncodingWOFF2

+ const EncodingWebManifest

+ const EncodingWebP

+ const EncodingWebmAudio

+ const EncodingWebmVideo

+ const EncodingXHTML

+ const EncodingXLSX

+ const EncodingXML

+ const EncodingZIP

+ const FieldContent

+ const FieldContentAlias

+ const FieldContentHash

+ const FieldContentHashAlias

+ const FieldContentSize

+ const FieldContentSizeAlias

+ const FieldDeleteBy

+ const FieldDeleteByAlias

+ const FieldEdges

+ const FieldEdgesAlias

+ const FieldEdgesDiffOmit

+ const FieldEdgesDiffOmitAlias

+ const FieldFieldsDiffOmit

+ const FieldFieldsDiffOmitAlias

+ const FieldHeight

+ const FieldHeightAlias

+ const FieldName

+ const FieldNameAlias

+ const FieldPubkeyExpiresAfter

+ const FieldPubkeyExpiresAfterAlias

+ const FieldPubkeyValidFrom

+ const FieldPubkeyValidFromAlias

+ const NodeBranches

+ const NodeContributor

+ const NodeDelete

+ const NodeExpiry

+ const NodeHead

+ const NodeTypBranches

+ const NodeTypeContributor

+ const NodeTypeHead

+ const ReservedPrefix

+ const SpineRevKey

+ const TargetBranches

+ const WireMediaType

+ var EdgeClasses = []EdgeClass

+ var ErrBranchNotCreatable = errors.New(...)

+ var ErrBranchNotFound = errors.New("ranke.Archive.GetBranch: branch not found")

+ var ErrClosed = errors.New("ranke: closed")

+ var ErrContentBothSlots = errors.New(...)

+ var ErrContentCapped = errors.New("ranke: content capped (stored shorter than content_size)")

+ var ErrCreatedAtNotMonotone = errors.New("ranke.verify: claim is dated before a claim it references")

+ var ErrDatedForm = errors.New(...)

+ var ErrDeleteByNotCopied = errors.New(...)

+ var ErrDeleteMarkNoTarget = errors.New(...)

+ var ErrEdgeOrder = errors.New("ranke.verify: a claim's edges are inlined ascending by id(e) (`V-EORDER`)")

+ var ErrEnvelopeHeaders = errors.New(...)

+ var ErrFutureDated = errors.New(...)

+ var ErrIDMismatch = errors.New("ranke.verify: the claim's id is not the hash of the envelope it is stored as")

+ var ErrIntegrity = errors.New("ranke: integrity check failed")

+ var ErrKeyExpired = errors.New(...)

+ var ErrKeyNotYetValid = errors.New("ranke.verify: claim is dated before its contributor key's pubkey_valid_from")

+ var ErrNotFound = errors.New("ranke: not found")

+ var ErrQueryBounds = errors.New("ranke.Query: value below the minimum the schema fixes for its field")

+ var ErrQueryComparisonForm = errors.New(...)

+ var ErrQueryEncoding = errors.New("ranke.Query: unknown Output.Encoding (native | json | cbor)")

+ var ErrQueryEnum = errors.New("ranke.Query: value outside the set the schema fixes for its field")

+ var ErrQueryEnvelopeAxis = errors.New(...)

+ var ErrQueryHops = errors.New("ranke.Query: a PathStep's hop bounds admit no count")

+ var ErrQueryLayerName = errors.New("ranke.Query: execution.layer names a layer, so a stated one may not be empty")

+ var ErrQueryNoHead = errors.New(...)

+ var ErrQueryNoScope = errors.New(...)

+ var ErrQueryOrderField = errors.New("ranke.Query: a sort key names the field it orders on")

+ var ErrQueryScanShape = errors.New(...)

+ var ErrQueryWhereForm = errors.New("ranke.Query: a where node is exactly one of and | or | not | {field, test}")

+ var ErrRelationDirection = errors.New(...)

+ var ErrReservedType = errors.New("ranke.Contribution: node type is the Sequencer's alone (lift it to add one)")

+ var ErrStructureNotDeletable = errors.New(...)

+ var ErrTimestampForm = errors.New(...)

+ var ErrUnknownTypeClass = errors.New("ranke.verify: type class is not one of the fixed set")

+ var ErrUnreadableReference = errors.New(...)

+ var ErrUnsupported = errors.New("ranke: operation not supported by this backend")

+ var ErrWire = errors.New("ranke.Wire")

+ var ErrWireKind = errors.New(...)

+ var ErrWireLateConstraint = errors.New("ranke.Wire: every constraint record precedes the payload")

+ var ErrWireNoBranch = errors.New("ranke.Wire: a claim record must name the branch it joins")

+ var ErrWireNoHeader = errors.New(...)

+ var ErrWireUndeclared = errors.New("ranke.Wire: claim names a branch the header does not declare")

+ func AdmitCreatedAt(c Claim, base time.Time) error

+ func BranchTagKey(branch string) string

+ func CheckDeletable(class NodeClass, sub string, fields map[string]string) error

+ func DecodePublicKey(b []byte) (multicodec.Code, crypto.PublicKey, error)

+ func DefaultClaimsInBranches(ctx context.Context, u Universe, branches map[string]Id, ids []Id) ([]bool, error)

+ func DefaultCopyClaims(ctx context.Context, dst, src Universe, ids []Id, opts ...CopyOption) error

+ func DefaultCopyContents(ctx context.Context, dst, src Universe, refs []ContentRef, opts ...CopyOption) error

+ func DefaultGetClaimHeights(ctx context.Context, u Universe, ids []Id) ([]uint64, error)

+ func DefaultSync(ctx context.Context, dst, src Universe, id Id) <-chan SyncResult

+ func DefaultTag(ctx context.Context, u Universe, head Id) error

+ func DrainWire(ctx context.Context, c Contribution, u Universe, wr *WireReader) error

+ func EncodePublicKey(pub crypto.PublicKey) ([]byte, error)

+ func EncodeQuery(q Query) ([]byte, error)

+ func EncodeResults(results []QueryResult, out Output) error

+ func EncodingApplication(sub string) string

+ func EncodingAudio(sub string) string

+ func EncodingExample(sub string) string

+ func EncodingFont(sub string) string

+ func EncodingImage(sub string) string

+ func EncodingMessage(sub string) string

+ func EncodingModel(sub string) string

+ func EncodingMultipart(sub string) string

+ func EncodingText(sub string) string

+ func EncodingVideo(sub string) string

+ func GetClaimHeight(ctx context.Context, u Universe, id Id) (uint64, error)

+ func GetTag(ctx context.Context, u Universe, id Id, tag string) (found bool, value string, err error)

+ func HasClaim(ctx context.Context, u Universe, id Id) (bool, error)

+ func HasContent(ctx context.Context, u Universe, id Id) (bool, error)

+ func HeightOf(refs ...Claim) uint64

+ func Hops(n int) *int

+ func InClosure(ctx context.Context, u Universe, branch string, heads []Id, id Id) (bool, error)

+ func IsTextEncoding(encoding string) bool

+ func LoadEd25519PrivateKeyPEM(path string) (ed25519.PrivateKey, error)

+ func LoadEd25519PublicKeyPEM(path string) (ed25519.PublicKey, error)

+ func MarshalCBOR(v any) ([]byte, error)

+ func NewVerifyingReader(src io.ReadCloser, hash Id, size uint64) (io.ReadCloser, error)

+ func PutClaim(ctx context.Context, u Universe, c Claim) error

+ func PutContent(ctx context.Context, u Universe, id Id, content []byte) error

+ func ReportEnabled(ctx context.Context, level ReportLevel) bool

+ func ReportEvent(ctx context.Context, engine, op string, level ReportLevel, detail string, ...)

+ func SyncedNow(id Id) <-chan SyncResult

+ func TemporalMidpointMs(s string) (int64, bool)

+ func TypeDerivation(sub string) string

+ func TypeEntity(sub string) string

+ func TypeRelation(sub string) string

+ func TypeSource(sub string) string

+ func ValidateQuery(q Query) error

+ func VerifyContent(hash Id, size uint64, data []byte) error

+ func WantsDelta(opts ...GetOption) bool

+ func WithDetail(sentinel error, detail string) error

+ func WithReport(ctx context.Context, level ReportLevel) (context.Context, func() []QueryEvent)

+ func Wrap(sentinel, cause error) error

+ func WrapDetail(sentinel error, detail string, cause error) error

+ type Archive interface

+ GetBranch func(ctx context.Context, name string) (Branch, error)

+ GetBranches func(ctx context.Context) ([]Branch, error)

+ GetClaim func(ctx context.Context, id Id) (Claim, error)

+ GetClaimContent func(ctx context.Context, id Id) (io.Reader, error)

+ HasBranch func(ctx context.Context, name string) (bool, error)

+ HasClaim func(ctx context.Context, id Id) (bool, error)

+ Head func() Id

+ MissingBranches func(ctx context.Context, names []string) ([]string, error)

+ Query func(ctx context.Context, q Query) (ResultStream, error)

+ Verify func(ctx context.Context, opts ...VerifyOption) (VerificationRun, error)

+ func NewArchive(ctx context.Context, u Universe, k Id) (Archive, error)

+ type Branch interface

+ GetClaim func(ctx context.Context, id Id) (Claim, error)

+ GetClaimContent func(ctx context.Context, id Id) (io.Reader, error)

+ HasClaim func(ctx context.Context, id Id) (bool, error)

+ Head func() Id

+ Name func() string

+ Prev func(ctx context.Context) (Branch, error)

+ Verify func(ctx context.Context, opts ...VerifyOption) (VerificationRun, error)

+ type Capabilities struct

+ ContentCap uint64

+ Delete bool

+ Enumerate bool

+ ExternalContent bool

+ Overwrite bool

+ Persistent bool

+ RawClaims bool

+ ReverseWalk bool

+ Tags bool

+ Tier StorageTier

+ func (c Capabilities) AllowsTier(t StorageTier) bool

+ type Claim interface

+ AsContributor func(ctx context.Context, u Universe, signingKey ...crypto.Signer) (Contributor, error)

+ Contributor func() Contributor

+ Edges func(filters ...Filter) []Edge

+ EncodeCBOR func(form Form) ([]byte, error)

+ EncodeJSON func(form Form) ([]byte, error)

+ Envelope func() ([]byte, error)

+ GetContent func(ctx context.Context, u Universe) (io.Reader, error)

+ HasTag func(key string) bool

+ ID func() Id

+ IsContributor func() bool

+ Node func() Node

+ SetTag func(ctx context.Context, u Universe) error

+ Tag func(key string) string

+ Tags func() map[string]string

+ func AssembleClaim(parts ClaimParts) (Claim, error)

+ func DecodeClaim(id Id, b []byte) (Claim, error)

+ func DefaultMaterialize(ctx context.Context, u Universe, claims []Claim, opts ...GetOption) ([]Claim, error)

+ func GetClaim(ctx context.Context, u Universe, id Id, opts ...GetOption) (Claim, error)

+ func GetFromClosure(ctx context.Context, u Universe, branch string, heads []Id, id Id) (Claim, error)

+ type ClaimBuilder struct

+ ContentHash Id

+ ContentSize uint64

+ Contributor Contributor

+ CreatedAt time.Time

+ Dated string

+ DiffOf Id

+ Edges []Edge

+ Encoding string

+ EncodingClass EncodingClass

+ EncodingSub string

+ Fields map[string]string

+ Height uint64

+ InlineContent []byte

+ SigningKey crypto.Signer

+ Type string

+ TypeClass NodeClass

+ TypeSub string

+ func NewClaim(typ string, contributor Contributor) ClaimBuilder

+ func (b ClaimBuilder) AllowInvalid() ClaimBuilder

+ func (b ClaimBuilder) Sign(signingKey ...crypto.Signer) (Claim, error)

+ func (b ClaimBuilder) WithAutoHeight(ctx context.Context, u Universe) ClaimBuilder

+ func (b ClaimBuilder) WithContributor(c Contributor) ClaimBuilder

+ func (b ClaimBuilder) WithCreatedAt(t time.Time) ClaimBuilder

+ func (b ClaimBuilder) WithDated(t time.Time) ClaimBuilder

+ func (b ClaimBuilder) WithDatedEDTF(d string) ClaimBuilder

+ func (b ClaimBuilder) WithDiff(id Id) ClaimBuilder

+ func (b ClaimBuilder) WithEdges(edges ...Edge) ClaimBuilder

+ func (b ClaimBuilder) WithEncoding(e string) ClaimBuilder

+ func (b ClaimBuilder) WithExternalContent(hash Id, size uint64) ClaimBuilder

+ func (b ClaimBuilder) WithField(key, value string) ClaimBuilder

+ func (b ClaimBuilder) WithHeight(h uint64) ClaimBuilder

+ func (b ClaimBuilder) WithInlineContent(c []byte) ClaimBuilder

+ func (b ClaimBuilder) WithSigningKey(k crypto.Signer) ClaimBuilder

+ func (b ClaimBuilder) WithType(t string) ClaimBuilder

+ type ClaimParts struct

+ ContentHash Id

+ ContentSize uint64

+ CreatedAt time.Time

+ Dated string

+ Edges []EdgeParts

+ Encoding string

+ Fields map[string]string

+ Height uint64

+ ID Id

+ InlineContent []byte

+ Tags map[string]string

+ Type string

+ type Collation string

+ const CompareLexical

+ const CompareNumeric

+ const CompareTemporal

+ type Comparison struct

+ Eq any

+ Ge any

+ Glob string

+ Gt any

+ In []any

+ Le any

+ Lt any

+ Ne any

+ type Constraints struct

+ func NewConstraints(opts ...ContributionOption) Constraints

+ func (c Constraints) AdmitBranch(ctx context.Context, base Archive, branch string) error

+ func (c Constraints) AdmitReferences(ctx context.Context, u Universe, base Archive, branch string, own []Claim) error

+ func (c Constraints) AdmitType(nodeType string) error

+ type ContentBlob struct

+ Content []byte

+ Hash Id

+ type ContentKind int

+ const ContentExternal

+ const ContentInline

+ const ContentNone

+ type ContentRef struct

+ ContentSize uint64

+ Hash Id

+ type Contribution interface

+ AddClaims func(branch string, claims []Claim) error

+ AddWire func(ctx context.Context, wr *WireReader) error

+ Base func() (head Id, t time.Time)

+ CompleteAndVerify func(ctx context.Context) (VerifiedContribution, error)

+ type ContributionOption func(*Constraints)

+ func WithCreatableBranches(branches ...string) ContributionOption

+ func WithLiftedTypes(types ...string) ContributionOption

+ func WithReferencableBranches(branches ...string) ContributionOption

+ type Contributor interface

+ Pubkey func() []byte

+ SigningKey func() crypto.Signer

+ func WithSigningKey(c Contributor, key crypto.Signer) Contributor

+ type CopyConfig struct

+ Closure bool

+ Content bool

+ Progress func(CopyProgress)

+ func NewCopyConfig(opts ...CopyOption) CopyConfig

+ type CopyOption func(*CopyConfig)

+ func WithClosure() CopyOption

+ func WithContent() CopyOption

+ func WithProgress(fn func(CopyProgress)) CopyOption

+ type CopyProgress struct

+ BytesCopied uint64

+ BytesRemaining uint64

+ ClaimsCopied uint64

+ ClaimsRemaining uint64

+ DiscoveryComplete bool

+ type Detail string

+ const DetailClaims

+ const DetailEnvelope

+ const DetailID

+ type Direction string

+ const DirConnections

+ const DirProvenance

+ const DirUses

+ type Edge interface

+ ContentComplete func() bool

+ ContentKind func() ContentKind

+ Encoding func() string

+ EncodingClass func() EncodingClass

+ EncodingSub func() string

+ Fields func() []string

+ GetContent func(ctx context.Context, u Universe) (io.Reader, error)

+ GetContentHash func() Id

+ GetContentSize func() uint64

+ GetField func(name string) (string, error)

+ GetInlineContent func() ([]byte, error)

+ HasField func(name string) bool

+ ID func() Id

+ Reference func() Id

+ RelationDirection func() RelationDirection

+ Type func() string

+ TypeClass func() EdgeClass

+ TypeSub func() string

+ func NewEdge(cfg EdgeConfig) (Edge, error)

+ type EdgeClass string

+ const EdgeClassContribution

+ const EdgeClassContributionAlias

+ const EdgeClassDerivation

+ const EdgeClassDerivationAlias

+ const EdgeClassRelation

+ const EdgeClassRelationAlias

+ type EdgeConfig struct

+ ContentHash Id

+ ContentSize uint64

+ Encoding string

+ Fields map[string]string

+ InlineContent []byte

+ Reference Id

+ Referenced Claim

+ RelationDirection RelationDirection

+ Type string

+ TypeClass EdgeClass

+ TypeSub string

+ type EdgeFilterFieldValue struct

+ Field string

+ Value string

+ func (f EdgeFilterFieldValue) IsEdgeFilter() bool

+ func (f EdgeFilterFieldValue) MatchEdge(e Edge) bool

+ func (f EdgeFilterFieldValue) MatchNode(Node) bool

+ type EdgeFilterType struct

+ Type string

+ func (f EdgeFilterType) IsEdgeFilter() bool

+ func (f EdgeFilterType) MatchEdge(e Edge) bool

+ func (f EdgeFilterType) MatchNode(Node) bool

+ type EdgeFilterTypes struct

+ Types []string

+ func (f EdgeFilterTypes) IsEdgeFilter() bool

+ func (f EdgeFilterTypes) MatchEdge(e Edge) bool

+ func (f EdgeFilterTypes) MatchNode(Node) bool

+ type EdgeParts struct

+ ContentHash Id

+ ContentSize uint64

+ Encoding string

+ Fields map[string]string

+ ID Id

+ InlineContent []byte

+ Reference Id

+ RelationDirection RelationDirection

+ Type string

+ type EdgeSubtype string

+ const EdgeSubtypeBranch

+ const EdgeSubtypeBranchAlias

+ const EdgeSubtypeBranches

+ const EdgeSubtypeBranchesAlias

+ const EdgeSubtypeContributor

+ const EdgeSubtypeContributorAlias

+ const EdgeSubtypeDelete

+ const EdgeSubtypeDeleteAlias

+ const EdgeSubtypeDiff

+ const EdgeSubtypeDiffAlias

+ const EdgeSubtypeExpiry

+ const EdgeSubtypeExpiryAlias

+ const EdgeSubtypeHead

+ const EdgeSubtypeHeadAlias

+ const EdgeSubtypePrune

+ const EdgeSubtypePruneAlias

+ type EncodingClass string

+ type EncodingSubtype string

+ type Execution struct

+ Layer string

+ Report ReportLevel

+ type Failure struct

+ Depth int

+ Err error

+ ID Id

+ type Field string

+ type Filter interface

+ IsEdgeFilter func() bool

+ MatchEdge func(e Edge) bool

+ MatchNode func(n Node) bool

+ type Form string

+ const FormMaterialized

+ const FormOriginal

+ type GetOption func(*getConfig)

+ func WithNotDiffMaterialized() GetOption

+ type Graph interface

+ AddClaims func(ctx context.Context, claims ...Claim) error

+ Cite func(ids ...Id)

+ Consolidate func(ctx context.Context, contributor Contributor, createdAt ...time.Time) (Claim, error)

+ ContainsClaim func(ctx context.Context, id Id) (bool, error)

+ GetClaim func(ctx context.Context, id Id) (Claim, error)

+ Heads func() []Id

+ IsConsolidated func() bool

+ Verify func(opts ...VerifyOption) VerificationRun

+ func NewGraph(ctx context.Context, u Universe) (Graph, error)

+ func NewGraphFromClosure(ctx context.Context, head Id, universe Universe) (Graph, error)

+ type HeightCache struct

+ func NewHeightCache() *HeightCache

+ func (c *HeightCache) Get(id Id) (uint64, bool)

+ func (c *HeightCache) GetClaimHeights(ctx context.Context, u Universe, ids []Id) ([]uint64, error)

+ func (c *HeightCache) Note(id Id, height uint64)

+ func (c *HeightCache) NoteClaims(cs ...Claim)

+ type History interface

+ Append func(ctx context.Context, id Id, height int, revision int) (HistoryItem, error)

+ Close func() error

+ GetAtRevision func(ctx context.Context, revision int) (HistoryItem, error)

+ GetBulk func(ctx context.Context, fromRevision, toExcludingRevision int) ([]HistoryItem, error)

+ Latest func(ctx context.Context) (HistoryItem, error)

+ Len func(ctx context.Context) (int, error)

+ type HistoryItem struct

+ func NewHistoryItem(id Id, revision int, height int, timestamp time.Time) HistoryItem

+ func SpliceHistory(existing, tagged []HistoryItem) []HistoryItem

+ func TagArchive(ctx context.Context, a Archive, opts ...TagArchiveOptions) ([]HistoryItem, error)

+ func (h HistoryItem) GetHeight() int

+ func (h HistoryItem) GetId() Id

+ func (h HistoryItem) GetRevision() int

+ func (h HistoryItem) GetTimestamp() time.Time

+ type Id interface

+ Algorithm func() string

+ Equal func(other Id) bool

+ String func() string

+ func HashContent(content []byte) (Id, error)

+ func ParseId(s string) (Id, error)

+ func StrandedByDeletion(ctx context.Context, u Universe, heads []Id, own []Claim) ([]Id, error)

+ type Keypair struct

+ Private crypto.Signer

+ Pubkey []byte

+ func LoadPrivateKey(path string) (Keypair, error)

+ type Limit struct

+ Results int

+ Time time.Duration

+ type MergableContribution interface

+ Heads func() map[string][]Id

+ type Node interface

+ ContentComplete func() bool

+ ContentKind func() ContentKind

+ CreatedAt func() time.Time

+ Dated func() string

+ Edges func() []Id

+ Encoding func() string

+ EncodingClass func() EncodingClass

+ EncodingSub func() string

+ Fields func() []string

+ GetContent func(ctx context.Context, u Universe) (io.Reader, error)

+ GetContentHash func() Id

+ GetContentSize func() uint64

+ GetField func(name string) (string, error)

+ GetInlineContent func() ([]byte, error)

+ HasField func(name string) bool

+ Height func() uint64

+ ID func() Id

+ Type func() string

+ TypeClass func() NodeClass

+ TypeSub func() string

+ type NodeClass string

+ const NodeClassContribution

+ const NodeClassContributionAlias

+ const NodeClassDerivation

+ const NodeClassDerivationAlias

+ const NodeClassEntity

+ const NodeClassEntityAlias

+ const NodeClassRelation

+ const NodeClassRelationAlias

+ const NodeClassSource

+ const NodeClassSourceAlias

+ type NodeSubtype string

+ const NodeSubtypeBranches

+ const NodeSubtypeBranchesAlias

+ const NodeSubtypeContributor

+ const NodeSubtypeContributorAlias

+ const NodeSubtypeDelete

+ const NodeSubtypeDeleteAlias

+ const NodeSubtypeExpiry

+ const NodeSubtypeExpiryAlias

+ const NodeSubtypeHead

+ const NodeSubtypeHeadAlias

+ type OrderKey struct

+ Compare Collation

+ Dir SortDir

+ Field string

+ type Output struct

+ Content *OutputContent

+ Detail Detail

+ Encoding ResultEncoding

+ Form Form

+ Shape Shape

+ type OutputContent struct

+ Max int

+ Overflow Overflow

+ type Overflow string

+ const OverflowCutoff

+ const OverflowOmit

+ type PathStep struct

+ Dir Direction

+ Edges []string

+ Max int

+ Min *int

+ Nodes []string

+ func (s PathStep) MinHops() int

+ type Query struct

+ Execution Execution

+ Limit Limit

+ Order []OrderKey

+ Output Output

+ Select Select

+ Where *Where

+ func DecodeQuery(data []byte) (Query, error)

+ type QueryEvent struct

+ At time.Duration

+ Attrs map[string]any

+ Detail string

+ Duration time.Duration

+ Engine string

+ Level ReportLevel

+ Op string

+ type QueryReport struct

+ Elapsed time.Duration

+ Events []QueryEvent

+ Results int

+ StartedAt time.Time

+ Truncated bool

+ func ReportOf(results []QueryResult) *QueryReport

+ type QueryResult struct

+ ClaimEncoded []byte

+ ClaimId Id

+ ClaimNative Claim

+ Kind ResultKind

+ PathEncoded [][]byte

+ PathId []Id

+ PathNative []Claim

+ Report *QueryReport

+ func AppendReport(results []QueryResult, rep *QueryReport) []QueryResult

+ type Receipt interface

+ Head func() Id

+ type RelationDirection int8

+ const RelationFrom

+ const RelationTo

+ type ReportLevel string

+ const ReportDebug

+ const ReportError

+ const ReportInfo

+ const ReportTrace

+ const ReportWarn

+ type ResultEncoding string

+ const ResultCBOR

+ const ResultJSON

+ const ResultNative

+ type ResultKind string

+ const KindClaimEncoded

+ const KindClaimEnvelope

+ const KindClaimId

+ const KindClaimNative

+ const KindPathEncoded

+ const KindPathEnvelope

+ const KindPathId

+ const KindPathNative

+ const KindReport

+ type ResultStream interface

+ Close func() error

+ Err func() error

+ Next func() bool

+ Report func() *QueryReport

+ Result func() QueryResult

+ func DefaultQuery(ctx context.Context, u Universe, q Query, scope Scope) (ResultStream, error)

+ type Scope struct

+ Branch string

+ Head Id

+ Height uint64

+ Revision int

+ type Select struct

+ Branch string

+ Claim Id

+ Head Id

+ Path []PathStep

+ type Sequencer interface

+ GetArchive func(ctx context.Context) (Archive, error)

+ GetContributor func() Contributor

+ Merge func(ctx context.Context, c MergableContribution) (Receipt, error)

+ NewContribution func(ctx context.Context, opts ...ContributionOption) (Contribution, error)

+ type Shape string

+ const ShapePath

+ const ShapeSingle

+ type SortDir string

+ const SortAsc

+ const SortDesc

+ type StorageTier string

+ const StorageTierAuthoritative

+ const StorageTierBackground

+ const StorageTierEager

+ const StorageTierLazy

+ type SweepResult struct

+ Claims []Id

+ Contents []Id

+ func DeletePlanned(ctx context.Context, u Universe, heads []Id, now time.Time) (SweepResult, error)

+ type SyncResult struct

+ Err error

+ SyncedTo Id

+ type TagArchiveOptions struct

+ RetagAll bool

+ type Universe interface

+ Capabilities func() Capabilities

+ ClaimsInBranches func(ctx context.Context, branches map[string]Id, ids []Id) ([]bool, error)

+ Close func() error

+ CopyClaims func(ctx context.Context, src Universe, ids []Id, opts ...CopyOption) error

+ CopyContents func(ctx context.Context, src Universe, refs []ContentRef, opts ...CopyOption) error

+ DeleteClaims func(ctx context.Context, ids []Id) error

+ DeleteContents func(ctx context.Context, hashes []Id) error

+ GetClaimHeights func(ctx context.Context, ids []Id) ([]uint64, error)

+ GetClaimTags func(ctx context.Context, claims []Id) ([]map[string]string, error)

+ GetClaims func(ctx context.Context, ids []Id, opts ...GetOption) ([]Claim, error)

+ GetClaimsRaw func(ctx context.Context, ids []Id) ([][]byte, error)

+ GetContents func(ctx context.Context, refs []ContentRef) ([][]byte, error)

+ HasClaims func(ctx context.Context, ids []Id) ([]bool, error)

+ HasContents func(ctx context.Context, hashes []Id) ([]bool, error)

+ PutClaims func(ctx context.Context, cs []Claim) error

+ PutContents func(ctx context.Context, blobs []ContentBlob) error

+ Query func(ctx context.Context, q Query, scope Scope) (ResultStream, error)

+ SetClaimsTags func(ctx context.Context, clearTags []string, tags map[string]map[string]string) error

+ StreamContent func(ctx context.Context, hash Id, size uint64) (io.ReadCloser, error)

+ Sync func(ctx context.Context, src Universe, id Id) <-chan SyncResult

+ Tag func(ctx context.Context, head Id) error

+ func NewMemoryUniverse() Universe

+ type VerificationRun interface

+ Done func() bool

+ Err func() error

+ Failures func() []Failure

+ Verified func() int

+ Wait func()

+ type VerifiedContribution interface

+ Ids func() []Id

+ Persist func(ctx context.Context) (MergableContribution, error)

+ type VerifyOption func(*verifyConfig)

+ func WithCreatedAfter(t time.Time) VerifyOption

+ func WithExternalContent() VerifyOption

+ func WithMaxClaims(n int) VerifyOption

+ func WithMaxDepth(n int) VerifyOption

+ func WithOnError(fn func(Failure)) VerifyOption

+ func WithSkipRules(names ...string) VerifyOption

+ func WithStopAfter(n int) VerifyOption

+ func WithTrusted(fn func(Id) bool) VerifyOption

+ type VerifyRule struct

+ Name string

+ Rule string

+ func VerifyRuleSet() []VerifyRule

+ type Where struct

+ And []Where

+ Field string

+ Not *Where

+ Or []Where

+ Test *Comparison

+ type WireConstraints struct

+ Branches []string

+ Creatable []string

+ Lifted []string

+ Referencable []string

+ func (w WireConstraints) Narrow(o WireConstraints) WireConstraints

+ func (w WireConstraints) Options() []ContributionOption

+ type WireKind uint64

+ const WireBranches

+ const WireClaim

+ const WireContent

+ const WireCreatable

+ const WireLifted

+ const WireReferencable

+ type WireReader struct

+ func NewWireReader(r io.Reader) *WireReader

+ func (wr *WireReader) Constraints() (WireConstraints, error)

+ func (wr *WireReader) Err() error

+ func (wr *WireReader) Next() bool

+ func (wr *WireReader) Record() WireRecord

+ type WireRecord struct

+ Blob ContentBlob

+ Branch string

+ Claim Claim

+ Kind WireKind

+ type WireWriter struct

+ func NewWireWriter(w io.Writer, cons WireConstraints) *WireWriter

+ func (ww *WireWriter) WriteClaim(branch string, c Claim) error

+ func (ww *WireWriter) WriteContent(b ContentBlob) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL