mirrors/gotosocial
1
0
Fork 0
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2025-10-31 02:32:25 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

finish writing code comments for the StatusTimeline{} type itself

Browse source
This commit is contained in:
kim 2025-04-01 14:10:53 +01:00
commit ba3ddd32f9
1 changed files with 11 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

14
internal/cache/timeline/status.go vendored
View file

@ -321,7 +321,12 @@ func (t *StatusTimeline) Init(cap int) {
t.max = cap t.max = cap
} }
// Load ... // Load will load timeline statuses according to given
// page, using provided callbacks to load extra data when
// necessary, and perform fine-grained filtering loaded
// database models before eventual return to the user. The
// returned strings are the lo, hi ID paging values, used
// for generation of next, prev page links in the response.
func (t *StatusTimeline) Load( func (t *StatusTimeline) Load(
ctx context.Context, ctx context.Context,
page *paging.Page, page *paging.Page,
@ -338,7 +343,7 @@ func (t *StatusTimeline) Load(
// what actually gets stored in the timeline cache. // what actually gets stored in the timeline cache.
preFilter func(each *gtsmodel.Status) (delete bool, err error), preFilter func(each *gtsmodel.Status) (delete bool, err error),
// postFilterFn can be used to perform filtering of returned // postFilter can be used to perform filtering of returned
// statuses AFTER insert into cache. i.e. this will not effect // statuses AFTER insert into cache. i.e. this will not effect
// what actually gets stored in the timeline cache. // what actually gets stored in the timeline cache.
postFilter func(each *gtsmodel.Status) (delete bool, err error), postFilter func(each *gtsmodel.Status) (delete bool, err error),
@ -686,7 +691,10 @@ func (t *StatusTimeline) UnprepareAll() {
} }
} }
// Trim ... // Trim will ensure that receiving timeline is less than or
// equal in length to the given threshold percentage of the
// timeline's preconfigured maximum capacity. This will trim
// from top / bottom depending on which was recently accessed.
func (t *StatusTimeline) Trim(threshold float64) { func (t *StatusTimeline) Trim(threshold float64) {
// Default trim dir. // Default trim dir.