spool

Documentation

Index

• Constants
• Variables
• type Credentials
• type FetchSubArgs
• type Spool
  • func New(fname string, concLimit uint, creds *reddit.Credentials) (*Spool, error)
  • func (s *Spool) AddGroupMetadata(name string, dateCreated time.Time, daysRetained uint) error
  • func (s *Spool) ArticleCount() (uint, error)
  • func (s *Spool) ArticleNumToRowIDCached(group string, articleNum uint) (store.RowID, error)
  • func (s *Spool) Close() error
  • func (s *Spool) FetchSubreddit(args FetchSubArgs) error
  • func (s *Spool) GetArticleByMsgID(group string, msgID string) (*data.Article, error)
  • func (s *Spool) GetArticleByNGNum(group string, articleNum uint) (*data.Article, error)
  • func (s *Spool) GetArticleNumsFromGroup(group string) ([]uint, error)
  • func (s *Spool) GetHeaderByMsgID(msgID string) (*data.Header, error)
  • func (s *Spool) GetHeaderByNGNum(group string, articleNum uint) (*data.Header, error)
  • func (s *Spool) GetRowIDsFromCache(group string) ([]store.RowID, error)
  • func (s *Spool) GroupArticleCount(group string) (int, error)
  • func (s *Spool) Init(startDate time.Time, prefix string) error
  • func (s *Spool) NewGroups(dt time.Time) ([]string, error)
  • func (s *Spool) Newsgroups() ([]string, error)
  • func (s *Spool) Prefix() (string, error)
  • func (s *Spool) StartDate() (*time.Time, error)

Constants

const ROWID_TTL = time.Duration(5) * time.Second

Variables

var ErrArticleNumNotFound = errors.New("article not found")

Types

type Credentials

type Credentials = reddit.Credentials

type FetchSubArgs

type FetchSubArgs struct {
	Subreddit      string
	StartDateTime  time.Time
	PageFetchLimit uint
	ConcLimit      uint
	IgnoreTick     bool
}

type Spool

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

func New

func New(fname string, concLimit uint, creds *reddit.Credentials) (*Spool, error)

func (*Spool) AddGroupMetadata

func (s *Spool) AddGroupMetadata(name string, dateCreated time.Time, daysRetained uint) error

func (*Spool) ArticleCount

func (s *Spool) ArticleCount() (uint, error)

func (*Spool) ArticleNumToRowIDCached

func (s *Spool) ArticleNumToRowIDCached(group string, articleNum uint) (store.RowID, error)

func (*Spool) Close

func (s *Spool) Close() error

func (*Spool) FetchSubreddit

func (s *Spool) FetchSubreddit(args FetchSubArgs) error

func (*Spool) GetArticleByMsgID

func (s *Spool) GetArticleByMsgID(group string, msgID string) (*data.Article, error)

func (*Spool) GetArticleByNGNum

func (s *Spool) GetArticleByNGNum(group string, articleNum uint) (*data.Article, error)

func (*Spool) GetArticleNumsFromGroup

func (s *Spool) GetArticleNumsFromGroup(group string) ([]uint, error)

func (*Spool) GetHeaderByMsgID

func (s *Spool) GetHeaderByMsgID(msgID string) (*data.Header, error)

func (*Spool) GetHeaderByNGNum

func (s *Spool) GetHeaderByNGNum(group string, articleNum uint) (*data.Header, error)

func (*Spool) GetRowIDsFromCache

func (s *Spool) GetRowIDsFromCache(group string) ([]store.RowID, error)

func (*Spool) GroupArticleCount

func (s *Spool) GroupArticleCount(group string) (int, error)

func (*Spool) Init

func (s *Spool) Init(startDate time.Time, prefix string) error

func (*Spool) NewGroups

func (s *Spool) NewGroups(dt time.Time) ([]string, error)

func (*Spool) Newsgroups

func (s *Spool) Newsgroups() ([]string, error)

func (*Spool) Prefix

func (s *Spool) Prefix() (string, error)

func (*Spool) StartDate

func (s *Spool) StartDate() (*time.Time, error)