Categorygithub.com/Ptt-official-app/go-bbs
modulepackage
0.12.0
Repository: https://github.com/ptt-official-app/go-bbs.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
10
Dependents
9
Files
849 SLOC

# README

BBS Library

GoDoc

這個專案是提供 Golang 開發者存取現有在台灣的 BBS 資料結構的函式庫。

目前主要支援的 BBS 結構以 pttbbs(CurrentPTT/OpenPTT) 為主

未來可能會支援 FormosaBBS

目前支援的檔案

目前 pttbbs 支援的檔案請見此處

給開發者的資訊

請點此

測試方式

go test

這樣。

專有名詞部分

有些名詞因為太常出現，可能會考慮直接在程式碼裡面以縮寫表示而不寫出全名：

  • BM: Board Moderator 版主的意思

授權

Apache 2.0

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

No description provided by the author
CstrToBytes Only the bytes until \0.See tests for more examples.
CstrToString Only the bytes until \0 when converting to string.See tests for more examples.
No description provided by the author
NewUserCommentRecord parses the data and returns the user comment record.
No description provided by the author
Open opan a.
No description provided by the author
No description provided by the author

# Constants

0.
1.
2.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author

# Structs

DB is whole bbs filesystem, including where file store, how to connect to local cache ( system V shared memory or etc.) how to parse or store it's data to bianry.

# Interfaces

No description provided by the author
BadPostUserRecord return UserRecord interface which support NumBadPosts.
No description provided by the author
No description provided by the author
No description provided by the author
Driver should implement Connector interface.
No description provided by the author
LastCountryUserRecord return UserRecord interface which support LastCountry.
MailboxUserRecord return UserRecord interface which support MailboxDescription.
UserArticleConnector is a connector for bbs who support cached user article records.
No description provided by the author
UserCommentConnector is a connector for bbs to access the cached user comment records.
No description provided by the author
No description provided by the author
UserDraftConnector is a connector for bbs which supports modify user draft file.
UserRecord mapping to `userec` in most system, it records uesr's basical data.
WriteArticleConnector is a connector for writing a article.
Driver which implement WriteBoardConnector supports modify board record file.

# Type aliases

Cstr []byte with C String property in that \0 is considered as the end of the bytes/string.It is used to convert from fixed-length bytes to string or []byte with no \0.
No description provided by the author