tir

Documentation

Overview

Package tir provides the interface-facing CRUD service.

Index

• Constants
• type Interface
  • func New(s store.Interface) Interface

Constants

const (
	// IDLength for hexadecimal text IDs.
	IDLength = 2 * 2 * 2
)

Types

type Interface

type Interface interface {
	io.Closer
	// Create a new text. This function is responsible for assigning
	// [text.Text.ID] and [text.Text.Timestamp].
	Create(new *text.Text) (*text.Text, error)
	// Read a text by its ID.
	Read(id string) (*text.Text, error)
	// Update a text with ID to include updates. Zero-valued fields in updates
	// (e.g. empty-string fields) are ignored.
	Update(id string, updates *text.Text) (*text.Text, error)
	// Delete a text by its ID.
	Delete(id string) (*text.Text, error)
	// List all texts sorted by decreasing [text.Text.Timestamp].
	List() ([]*text.Text, error)
}

Interface for managing tir texts. Callers should use this in lieu of store.Store; the latter assumes application-level validation implemented in this package. See New.

func New

func New(s store.Interface) Interface

New constructs a new application Interface around s. In general, use github.com/lukasschwab/tiir/pkg/config.Load instead to respect user configuration.