Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FileInfoPile ¶
type FileInfoPile struct {
// contains filtered or unexported fields
}
FileInfoPile is a hybrid container for a lazily and concurrently populated growing-only slice of items (of type `os.FileInfo`) which may be traversed in parallel to it's growth.
Usage for a pile `p`:
p := MakeFileInfoPile(128, 32)
Have it grow concurrently using multiple:
var item os.FileInfo = something p.Pile(item)
in as many go routines as You may seem fit.
In parallel, You may either traverse `p` in parallel right away:
for item, ok := p.Iter(); ok; item, ok = p.Next() { ... do sth with item ... }
Here p.Iter() starts a new transversal with the first item (if any), and p.Next() keeps traverses the FileInfoPile.
or traverse blocking / awaiting close first:
for item := range <-p.Done() { ... do sth with item ... }
or use the result when available:
r, p := <-p.Done(), nil
Hint: here we get the result in `r` and at the same time discard / deallocate / forget the pile `p` itself.
Note: The traversal is *not* intended to be concurrency safe! Thus: You may call `Pile` concurrently to Your traversal, but use of either `Done` or `Iter` and `Next` *must* be confined to a single go routine (thread).
func MakeFileInfoPile ¶
func MakeFileInfoPile(size, buff int) *FileInfoPile
MakeFileInfoPile returns a (pointer to a) fresh pile of items (of type `os.FileInfo`) with size as initial capacity and with buff as initial leeway, allowing as many Pile's to execute non-blocking before respective Done or Next's.
func (*FileInfoPile) Close ¶
func (d *FileInfoPile) Close() (err error)
Close - call once when everything has been piled.
Close intentionally implements io.Closer ¶
Note: After Close(), any Close(...) will panic and any Pile(...) will panic and any Done() or Next() will return immediately: no eventual blocking, that is.
func (*FileInfoPile) Done ¶
func (d *FileInfoPile) Done() (done <-chan []os.FileInfo)
Done returns a channel which emits the result (as slice of FileInfo) once the pile is closed.
Users of Done() *must not* iterate (via Iter() Next()...) before the done-channel is closed!
Done is a convenience - useful iff You do not like/need to start any traversal before the pile is fully populated. Once the pile is closed, Done() will signal in constant time.
Note: Upon signalling, the pile is reset to it's tip, so You may traverse it (via Next) right away. Usage for a pile `p`: Traverse blocking / awaiting close first:
for item := range <-p.Done() { ... do sth with item ... }
or use the result when available
r, p := <-p.Done(), nil
while discaring the pile itself.
func (*FileInfoPile) Iter ¶
func (d *FileInfoPile) Iter() (item os.FileInfo, ok bool)
Iter puts the pile iterator back to the beginning and returns the first `Next()`, iff any. Usage for a pile `p`:
for item, ok := p.Iter(); ok; item, ok = p.Next() { ... do sth with item ... }
func (*FileInfoPile) Next ¶
func (d *FileInfoPile) Next() (item os.FileInfo, ok bool)
Next returns the next item, or false iff the pile is exhausted.
Note: Iff the pile is not closed yet, Next may block, awaiting some Pile().
func (*FileInfoPile) Pile ¶
func (d *FileInfoPile) Pile(item os.FileInfo)
Pile appends an `os.FileInfo` item to the FileInfoPile.
Note: Pile will block iff buff is exceeded and no Done() or Next()'s are used.
type FilePile ¶
type FilePile struct {
// contains filtered or unexported fields
}
FilePile is a hybrid container for a lazily and concurrently populated growing-only slice of items (of type `*os.File`) which may be traversed in parallel to it's growth.
Usage for a pile `p`:
p := MakeFilePile(128, 32)
Have it grow concurrently using multiple:
var item *os.File = something p.Pile(item)
in as many go routines as You may seem fit.
In parallel, You may either traverse `p` in parallel right away:
for item, ok := p.Iter(); ok; item, ok = p.Next() { ... do sth with item ... }
Here p.Iter() starts a new transversal with the first item (if any), and p.Next() keeps traverses the FilePile.
or traverse blocking / awaiting close first:
for item := range <-p.Done() { ... do sth with item ... }
or use the result when available:
r, p := <-p.Done(), nil
Hint: here we get the result in `r` and at the same time discard / deallocate / forget the pile `p` itself.
Note: The traversal is *not* intended to be concurrency safe! Thus: You may call `Pile` concurrently to Your traversal, but use of either `Done` or `Iter` and `Next` *must* be confined to a single go routine (thread).
func MakeFilePile ¶
MakeFilePile returns a (pointer to a) fresh pile of items (of type `*os.File`) with size as initial capacity and with buff as initial leeway, allowing as many Pile's to execute non-blocking before respective Done or Next's.
func (*FilePile) Close ¶
Close - call once when everything has been piled.
Close intentionally implements io.Closer ¶
Note: After Close(), any Close(...) will panic and any Pile(...) will panic and any Done() or Next() will return immediately: no eventual blocking, that is.
func (*FilePile) Done ¶
Done returns a channel which emits the result (as slice of File) once the pile is closed.
Users of Done() *must not* iterate (via Iter() Next()...) before the done-channel is closed!
Done is a convenience - useful iff You do not like/need to start any traversal before the pile is fully populated. Once the pile is closed, Done() will signal in constant time.
Note: Upon signalling, the pile is reset to it's tip, so You may traverse it (via Next) right away. Usage for a pile `p`: Traverse blocking / awaiting close first:
for item := range <-p.Done() { ... do sth with item ... }
or use the result when available
r, p := <-p.Done(), nil
while discaring the pile itself.
func (*FilePile) Iter ¶
Iter puts the pile iterator back to the beginning and returns the first `Next()`, iff any. Usage for a pile `p`:
for item, ok := p.Iter(); ok; item, ok = p.Next() { ... do sth with item ... }
type SignalPile ¶
type SignalPile struct {
// contains filtered or unexported fields
}
SignalPile is a hybrid container for a lazily and concurrently populated growing-only slice of items (of type `os.Signal`) which may be traversed in parallel to it's growth.
Usage for a pile `p`:
p := MakeSignalPile(128, 32)
Have it grow concurrently using multiple:
var item os.Signal = something p.Pile(item)
in as many go routines as You may seem fit.
In parallel, You may either traverse `p` in parallel right away:
for item, ok := p.Iter(); ok; item, ok = p.Next() { ... do sth with item ... }
Here p.Iter() starts a new transversal with the first item (if any), and p.Next() keeps traverses the SignalPile.
or traverse blocking / awaiting close first:
for item := range <-p.Done() { ... do sth with item ... }
or use the result when available:
r, p := <-p.Done(), nil
Hint: here we get the result in `r` and at the same time discard / deallocate / forget the pile `p` itself.
Note: The traversal is *not* intended to be concurrency safe! Thus: You may call `Pile` concurrently to Your traversal, but use of either `Done` or `Iter` and `Next` *must* be confined to a single go routine (thread).
func MakeSignalPile ¶
func MakeSignalPile(size, buff int) *SignalPile
MakeSignalPile returns a (pointer to a) fresh pile of items (of type `os.Signal`) with size as initial capacity and with buff as initial leeway, allowing as many Pile's to execute non-blocking before respective Done or Next's.
func (*SignalPile) Close ¶
func (d *SignalPile) Close() (err error)
Close - call once when everything has been piled.
Close intentionally implements io.Closer ¶
Note: After Close(), any Close(...) will panic and any Pile(...) will panic and any Done() or Next() will return immediately: no eventual blocking, that is.
func (*SignalPile) Done ¶
func (d *SignalPile) Done() (done <-chan []os.Signal)
Done returns a channel which emits the result (as slice of Signal) once the pile is closed.
Users of Done() *must not* iterate (via Iter() Next()...) before the done-channel is closed!
Done is a convenience - useful iff You do not like/need to start any traversal before the pile is fully populated. Once the pile is closed, Done() will signal in constant time.
Note: Upon signalling, the pile is reset to it's tip, so You may traverse it (via Next) right away. Usage for a pile `p`: Traverse blocking / awaiting close first:
for item := range <-p.Done() { ... do sth with item ... }
or use the result when available
r, p := <-p.Done(), nil
while discaring the pile itself.
func (*SignalPile) Iter ¶
func (d *SignalPile) Iter() (item os.Signal, ok bool)
Iter puts the pile iterator back to the beginning and returns the first `Next()`, iff any. Usage for a pile `p`:
for item, ok := p.Iter(); ok; item, ok = p.Next() { ... do sth with item ... }
func (*SignalPile) Next ¶
func (d *SignalPile) Next() (item os.Signal, ok bool)
Next returns the next item, or false iff the pile is exhausted.
Note: Iff the pile is not closed yet, Next may block, awaiting some Pile().
func (*SignalPile) Pile ¶
func (d *SignalPile) Pile(item os.Signal)
Pile appends an `os.Signal` item to the SignalPile.
Note: Pile will block iff buff is exceeded and no Done() or Next()'s are used.
Source Files