dataaccess

Documentation

Index

• type File
• type Item
• type ItemState
• type ItemType
  • func (itemType ItemType) String() string
• type ItemsProvider
• type LiveReload
• type PathProvider
• type Repository
• type RoutesProvider
• type Subscriber
• type Update
  • func NewUpdate(newItemRoutes, modifiedItemRoutes, deletedItemRoutes []route.Route) Update
  • func (update *Update) Deleted() []route.Route
  • func (update *Update) IsEmpty() bool
  • func (update *Update) Modified() []route.Route
  • func (update *Update) New() []route.Route
  • func (update *Update) String() string

Types

type File

type File interface {
	content.ContentProviderInterface

	String() string
	Id() string
	Name() string
	Parent() route.Route
	Route() route.Route
}

A File represents a file ressource that is associated with an Item.

type Item

type Item interface {
	content.ContentProviderInterface

	String() string
	Id() string
	Type() ItemType
	CanHaveChildren() bool
	Route() route.Route
	Files() []File
	LastHash() string
}

An Item represents a single document in a repository.

type ItemState

type ItemState int

const (
	ItemStateStable ItemState = iota
	ItemStateNew
	ItemStateModified
	ItemStateDeleted
)

type ItemType

type ItemType int

const (
	TypePhysical ItemType = iota
	TypeVirtual
	TypeFileCollection
)

func (ItemType) String

func (itemType ItemType) String() string

type ItemsProvider

type ItemsProvider interface {
	Items() []Item
	Item(route route.Route) Item
}

type LiveReload

type LiveReload interface {
	StartWatching(route route.Route)
	StopWatching(route route.Route)
}

type PathProvider

type PathProvider interface {
	Path() string
}

type Repository

type Repository interface {
	PathProvider
	ItemsProvider
	RoutesProvider
	Subscriber
	LiveReload
}

type RoutesProvider

type RoutesProvider interface {
	Routes() []route.Route
}

type Subscriber

type Subscriber interface {
	Subscribe(updates chan Update)
}

type Update

type Update struct {
	// contains filtered or unexported fields
}

Update contains a list of new, modified and deleted routes.

func NewUpdate

func NewUpdate(newItemRoutes, modifiedItemRoutes, deletedItemRoutes []route.Route) Update

NewUpdate creates a new Update instance from the given new, modified and deleted routes.

func (*Update) Deleted

func (update *Update) Deleted() []route.Route

Deleted returns the routes of releted items.

func (*Update) IsEmpty

func (update *Update) IsEmpty() bool

IsEmpty indicates whether this Update is empty or not.

func (*Update) Modified

func (update *Update) Modified() []route.Route

Modified returns the routes of modified items.

func (*Update) New

func (update *Update) New() []route.Route

New returns the routes of new items.

func (*Update) String

func (update *Update) String() string