Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CodeframePipe ¶
type CodeframePipe interface {
ProcessCodeframeRecords(in chan *records.CodeframeRecord) chan *records.CodeframeRecord
}
interface to be implemented by any report/processor working with stream of codeframe records
type CodeframePipeline ¶
type CodeframePipeline struct {
// contains filtered or unexported fields
}
pipeline to attach multiple reports to the codeframe stream
func NewCodeframePipeline ¶
func NewCodeframePipeline(pipes ...CodeframePipe) CodeframePipeline
construct a linked pipeline of reports that process codeframe records
func (*CodeframePipeline) Close ¶
func (p *CodeframePipeline) Close()
closes the pipeline and cascades termination to all individual reports
func (*CodeframePipeline) Dequeue ¶
func (p *CodeframePipeline) Dequeue(handler func(*records.CodeframeRecord))
allows the attachment of a terminating reader at the end of the pipeline such as progress-bar update or audit log.
func (*CodeframePipeline) Enqueue ¶
func (p *CodeframePipeline) Enqueue(item *records.CodeframeRecord)
allows items to be injected into the pipeline from a source such as a reports.Emitter{}
type EventPipe ¶
type EventPipe interface {
ProcessEventRecords(in chan *records.EventOrientedRecord) chan *records.EventOrientedRecord
}
interface to be implemented by any report working with stream of event records
type EventPipeline ¶
type EventPipeline struct {
// contains filtered or unexported fields
}
pipeline to attach multiple reports to the event stream
func NewEventPipeline ¶
func NewEventPipeline(pipes ...EventPipe) EventPipeline
construct a linked pipeline of reports that process event-based records
func (*EventPipeline) Close ¶
func (p *EventPipeline) Close()
closes the pipeline and cascades termination to all individual reports
func (*EventPipeline) Dequeue ¶
func (p *EventPipeline) Dequeue(handler func(*records.EventOrientedRecord))
allows the attachment of a terminating reader at the end of the pipeline such as progress-bar update or audit log.
func (*EventPipeline) Enqueue ¶
func (p *EventPipeline) Enqueue(item *records.EventOrientedRecord)
allows items to be injected into the pipeline from a source such as a reports.Emitter{}
type ObjectPipe ¶
type ObjectPipe interface {
ProcessObjectRecords(in chan *records.ObjectRecord) chan *records.ObjectRecord
}
interface to be implemented by any report/processor working with stream of Object records
type ObjectPipeline ¶
type ObjectPipeline struct {
// contains filtered or unexported fields
}
pipeline to attach multiple reports to the Object stream
func NewObjectPipeline ¶
func NewObjectPipeline(pipes ...ObjectPipe) ObjectPipeline
construct a linked pipeline of reports that process Object records
func (*ObjectPipeline) Close ¶
func (p *ObjectPipeline) Close()
closes the pipeline and cascades termination to all individual reports
func (*ObjectPipeline) Dequeue ¶
func (p *ObjectPipeline) Dequeue(handler func(*records.ObjectRecord))
allows the attachment of a terminating reader at the end of the pipeline such as progress-bar update or audit log.
func (*ObjectPipeline) Enqueue ¶
func (p *ObjectPipeline) Enqueue(item *records.ObjectRecord)
allows items to be injected into the pipeline from a source such as a reports.Emitter{}
type StudentPipe ¶
type StudentPipe interface {
ProcessStudentRecords(in chan *records.StudentOrientedRecord) chan *records.StudentOrientedRecord
}
interface to be implemented by any report/processor working with stream of Object records
type StudentPipeline ¶
type StudentPipeline struct {
// contains filtered or unexported fields
}
pipeline to attach multiple reports to the Object stream
func NewStudentPipeline ¶
func NewStudentPipeline(pipes ...StudentPipe) StudentPipeline
construct a linked pipeline of reports that process Object records
func (*StudentPipeline) Close ¶
func (p *StudentPipeline) Close()
closes the pipeline and cascades termination to all individual reports
func (*StudentPipeline) Dequeue ¶
func (p *StudentPipeline) Dequeue(handler func(*records.StudentOrientedRecord))
allows the attachment of a terminating reader at the end of the pipeline such as progress-bar update or audit log.
func (*StudentPipeline) Enqueue ¶
func (p *StudentPipeline) Enqueue(item *records.StudentOrientedRecord)
allows items to be injected into the pipeline from a source such as a reports.Emitter{}
Source Files