graph

Documentation

Index

• Variables
• type Edge
• type EdgeIterator
• type Graph
• type Iterator
• type Link
• type LinkIterator

Variables

var (
	ErrNotFound = xerrors.New("not found")

	// ErrUnknownEdgeLinks is returned when attempting to create an edge
	// with an invalid source and/or destination ID
	ErrUnknownEdgeLinks = xerrors.New("unknown source and/or destination for edge")
)

Types

type Edge

type Edge struct {
	ID        uuid.UUID
	Src       uuid.UUID
	Dst       uuid.UUID
	UpdatedAt time.Time
}

type EdgeIterator

type EdgeIterator interface {
	Iterator
	Edge() *Edge
}

type Graph

type Graph interface {
	UpsertLink(*Link) error
	FindLink(uuid.UUID) (*Link, error)

	UpsertEdge(*Edge) error
	RemoveStaleEdges(fromID uuid.UUID, updatedBefore time.Time) error

	Links(fromID, toID uuid.UUID, retreviedBefore time.Time) (LinkIterator, error)
	Edges(fromID, toID uuid.UUID, updatedBefore time.Time) (EdgeIterator, error)
}

type Iterator

type Iterator interface {
	Next() bool
	Error() error
	Close() error
}

type Link

type Link struct {
	ID          uuid.UUID
	URL         string
	RetreivedAt time.Time
}

type LinkIterator

type LinkIterator interface {
	Iterator
	Link() *Link
}