boards source pure

1func IsRepost(thread *Post) bool

1func IsThread(p *Post) bool

1func SummaryOf(text string, length int) string

1func New(id ID) *Board

1func NewFlagStorage() FlagStorage

1func NewIdentifierGenerator() IdentifierGenerator

1func NewPermissionSet(perms ...Permission) PermissionSet

1func MustNewReply(parent *Post, creator address, body string) *Post

1func MustNewRepost(thread *Post, dst *Board, creator address) *Post

1func MustNewThread(b *Board, creator address, title, body string) *Post

1func NewReply(parent *Post, creator address, body string) (*Post, error)

1func NewRepost(thread *Post, dst *Board, creator address) (*Post, error)

1func NewThread(b *Board, creator address, title, body string) (*Post, error)

1func NewPostStorage() PostStorage

1func NewRepostStorage() RepostStorage

1func NewStorage() Storage

1type Args []interface{}

 1type Board struct {
 2	// ID is the unique identifier of the board.
 3	ID ID
 4
 5	// Name is the current name of the board.
 6	Name string
 7
 8	// Aliases contains a list of alternative names for the board.
 9	Aliases []string
10
11	// Readonly indicates that the board is readonly.
12	Readonly bool
13
14	// Threads contains board threads.
15	Threads PostStorage
16
17	// ThreadsSequence generates sequential ID for new threads.
18	ThreadsSequence IdentifierGenerator
19
20	// Permissions enables support for permissioned boards.
21	// This type of boards allows managing members with roles and permissions.
22	// It also enables the implementation of permissioned execution of board related features.
23	Permissions Permissions
24
25	// Creator is the account address that created the board.
26	Creator address
27
28	// Meta allows storing board metadata.
29	Meta any
30
31	// CreatedAt is the board's creation time.
32	CreatedAt time.Time
33
34	// UpdatedAt is the board's update time.
35	UpdatedAt time.Time
36}

1type BoardIterFn func(*Board) bool

1type Flag struct {
2	// User is the user that flagged the post.
3	User address
4
5	// Reason is the reason that describes why post is flagged.
6	Reason string
7}

1type FlagIterFn func(Flag) bool

 1type FlagStorage interface {
 2	// Exists checks if a flag from a user exists
 3	Exists(address) bool
 4
 5	// Add adds a new flag from a user.
 6	Add(Flag) error
 7
 8	// Remove removes a user flag.
 9	Remove(address) (removed bool)
10
11	// Size returns the number of flags in the storage.
12	Size() int
13
14	// Iterate iterates post flags.
15	// To reverse iterate flags use a negative count.
16	// If the callback returns true, the iteration is stopped.
17	Iterate(start, count int, fn FlagIterFn) bool
18}

1type ID uint64

1type IdentifierGenerator interface {
2	// Current returns the last generated ID.
3	Last() ID
4
5	// Next generates a new ID or panics if increasing ID overflows.
6	Next() ID
7}

1type Permission uint16

1type PermissionSet []uint64

 1type Permissions interface {
 2	// HasRole checks if a user has a specific role assigned.
 3	HasRole(address, Role) bool
 4
 5	// HasPermission checks if a user has a specific permission.
 6	HasPermission(address, Permission) bool
 7
 8	// WithPermission calls a callback when a user has a specific permission.
 9	// It panics on error.
10	//
11	// An inline crossing function call can be used by the implementation if
12	// crossing is required to update its internal state, for example to create
13	// proposals that when approved execute the callback:
14	//
15	//  func(realm) {
16	//    // Update internal realm state
17	//    // ...
18	//  }(cross)
19	WithPermission(address, Permission, Args, func())
20
21	// SetUserRoles adds a new user when it doesn't exist and sets its roles.
22	// Method can also be called to change the roles of an existing user.
23	// It panics on error.
24	SetUserRoles(address, ...Role)
25
26	// RemoveUser removes a user from the permissioner.
27	// It panics on error.
28	RemoveUser(address) (removed bool)
29
30	// HasUser checks if a user exists.
31	HasUser(address) bool
32
33	// UsersCount returns the total number of users the permissioner contains.
34	UsersCount() int
35
36	// IterateUsers iterates permissions' users.
37	IterateUsers(start, count int, fn UsersIterFn) bool
38}

 1type Post struct {
 2	// ID is the unique identifier of the post.
 3	ID ID
 4
 5	// ParentID is the ID of the parent post.
 6	ParentID ID
 7
 8	// ThreadID contains the post ID of the thread where current post is created.
 9	// If current post is a thread it contains post's ID.
10	// It should be used when current post is a thread or reply.
11	ThreadID ID
12
13	// OriginalBoardID contains the board ID of the original post when current post is a repost.
14	OriginalBoardID ID
15
16	// Board contains the board where post is created.
17	Board *Board
18
19	// Title contains the post's title.
20	Title string
21
22	// Body contains content of the post.
23	Body string
24
25	// Hidden indicates that the post is hidden.
26	Hidden bool
27
28	// Readonly indicates that the post is readonly.
29	Readonly bool
30
31	// Replies stores post replies.
32	Replies PostStorage
33
34	// Reposts stores reposts of the current post.
35	// It should be used when post is a thread.
36	Reposts RepostStorage
37
38	// Flags stores users flags for the current post.
39	Flags FlagStorage
40
41	// Creator is the account address that created the post.
42	Creator address
43
44	// Meta allows storing post metadata.
45	Meta any
46
47	// CreatedAt is the post's creation time.
48	CreatedAt time.Time
49
50	// UpdatedAt is the post's update time.
51	UpdatedAt time.Time
52}

1type PostIterFn func(*Post) bool

 1type PostStorage interface {
 2	// Get retruns a post that matches an ID.
 3	Get(ID) (_ *Post, found bool)
 4
 5	// Remove removes a post from the storage.
 6	Remove(ID) (_ *Post, removed bool)
 7
 8	// Add adds a post in the storage.
 9	Add(*Post) error
10
11	// Size returns the number of posts in the storage.
12	Size() int
13
14	// Iterate iterates posts.
15	// To reverse iterate posts use a negative count.
16	// If the callback returns true, the iteration is stopped.
17	Iterate(start, count int, fn PostIterFn) bool
18}

1type RepostIterFn func(board, repost ID) bool

 1type RepostStorage interface {
 2	// Get returns the repost ID for a board.
 3	Get(board ID) (repost ID, found bool)
 4
 5	// Add adds a new repost to the storage.
 6	Add(repost *Post) error
 7
 8	// Remove removes repost for a board.
 9	Remove(board ID) (removed bool)
10
11	// Size returns the number of reposts in the storage.
12	Size() int
13
14	// Iterate iterates reposts.
15	// To reverse iterate reposts use a negative count.
16	// If the callback returns true, the iteration is stopped.
17	Iterate(start, count int, fn RepostIterFn) bool
18}

1type Role string

 1type Storage interface {
 2	// Get retruns a boards that matches an ID.
 3	Get(ID) (_ *Board, found bool)
 4
 5	// GetByName retruns a boards that matches a name.
 6	GetByName(name string) (_ *Board, found bool)
 7
 8	// Remove removes a board from the storage.
 9	Remove(ID) (_ *Board, removed bool)
10
11	// Add adds a board to the storage.
12	Add(*Board) error
13
14	// Size returns the number of boards in the storage.
15	Size() int
16
17	// Iterate iterates boards.
18	// To reverse iterate boards use a negative count.
19	// If the callback returns true, the iteration is stopped.
20	Iterate(start, count int, fn BoardIterFn) bool
21}

1type User struct {
2	Address address
3	Roles   []Role
4}

1type UsersIterFn func(User) bool