options

Documentation

Index

• type AddOption
  • func FollowKey(key *symmetric.Key) AddOption
  • func ReadKey(key *symmetric.Key) AddOption
• type AddOptions
• type SubOption
  • func ThreadID(id thread.ID) SubOption
• type SubOptions

Types

type AddOption

type AddOption func(*AddOptions)

AddOption is an add thread option.

func FollowKey

func FollowKey(key *symmetric.Key) AddOption

FollowKey allows thread record traversal.

func ReadKey

func ReadKey(key *symmetric.Key) AddOption

ReadKey allows for thread record decryption.

type AddOptions

type AddOptions struct {
	FollowKey *symmetric.Key
	ReadKey   *symmetric.Key
}

AddOptions defines options for adding a new thread.

type SubOption

type SubOption func(*SubOptions)

SubOption is a thread subscription option.

func ThreadID

func ThreadID(id thread.ID) SubOption

ThreadID restricts the subscription to the given thread. Use this option multiple times to build up a list of threads to subscribe to.

type SubOptions

type SubOptions struct {
	ThreadIDs thread.IDSlice
}

SubOptions defines options for a thread subscription.