scipipe: github.com/scipipe/scipipe/components Index | Files

package components

import "github.com/scipipe/scipipe/components"

Index

Package Files

concatenator.go file_globber.go file_reader.go file_splitter.go file_writer.go maptokeys.go streamtosubstream.go stringgen.go strtobyte.go utils.go

func Check Uses

func Check(err error)

func NewStrToByte Uses

func NewStrToByte(wf *scipipe.Workflow, name string) *strToByte

type Concatenator Uses

type Concatenator struct {
    scipipe.Process

    In      *scipipe.FilePort
    Out     *scipipe.FilePort
    OutPath string
    // contains filtered or unexported fields
}

func NewConcatenator Uses

func NewConcatenator(wf *scipipe.Workflow, name string, outPath string) *Concatenator

func (*Concatenator) IsConnected Uses

func (proc *Concatenator) IsConnected() bool

func (*Concatenator) Name Uses

func (proc *Concatenator) Name() string

func (*Concatenator) Run Uses

func (proc *Concatenator) Run()

type FileGlobber Uses

type FileGlobber struct {
    scipipe.Process

    Out *scipipe.FilePort
    // contains filtered or unexported fields
}

func NewFileGlobber Uses

func NewFileGlobber(wf *scipipe.Workflow, name string, globPattern string) *FileGlobber

func (*FileGlobber) IsConnected Uses

func (p *FileGlobber) IsConnected() bool

func (*FileGlobber) Name Uses

func (p *FileGlobber) Name() string

func (*FileGlobber) Run Uses

func (p *FileGlobber) Run()

type FileReader Uses

type FileReader struct {
    scipipe.Process

    FilePath chan string
    OutLine  chan []byte
    // contains filtered or unexported fields
}

FileReader takes a file path on its FilePath in-port, and returns the file content as []byte on its out-port Out

func NewFileReader Uses

func NewFileReader(wf *scipipe.Workflow, name string) *FileReader

Instantiate a new FileReader

func (*FileReader) Name Uses

func (proc *FileReader) Name() string

func (*FileReader) Run Uses

func (proc *FileReader) Run()

Run the FileReader

type FileSplitter Uses

type FileSplitter struct {
    scipipe.Process

    InFile        *scipipe.FilePort
    OutSplitFile  *scipipe.FilePort
    LinesPerSplit int
    // contains filtered or unexported fields
}

func NewFileSplitter Uses

func NewFileSplitter(wf *scipipe.Workflow, name string, linesPerSplit int) *FileSplitter

func (*FileSplitter) IsConnected Uses

func (proc *FileSplitter) IsConnected() bool

func (*FileSplitter) Name Uses

func (proc *FileSplitter) Name() string

func (*FileSplitter) Run Uses

func (proc *FileSplitter) Run()

type FileWriter Uses

type FileWriter struct {
    scipipe.Process

    In       chan []byte
    FilePath chan string
    // contains filtered or unexported fields
}

FileWriter takes a file path on its FilePath in-port, file contents on its In in-port and write the file contents to a file with the specified path.

func NewFileWriter Uses

func NewFileWriter(wf *scipipe.Workflow, name string) *FileWriter

func NewFileWriterFromPath Uses

func NewFileWriterFromPath(wf *scipipe.Workflow, path string) *FileWriter

func (*FileWriter) IsConnected Uses

func (proc *FileWriter) IsConnected() bool

func (*FileWriter) Name Uses

func (p *FileWriter) Name() string

func (*FileWriter) Run Uses

func (proc *FileWriter) Run()

type MapToKeys Uses

type MapToKeys struct {
    In  *scipipe.FilePort
    Out *scipipe.FilePort
    // contains filtered or unexported fields
}

func NewMapToKeys Uses

func NewMapToKeys(wf *scipipe.Workflow, name string, mapFunc func(ip *scipipe.InformationPacket) map[string]string) *MapToKeys

func (*MapToKeys) IsConnected Uses

func (p *MapToKeys) IsConnected() bool

func (*MapToKeys) Name Uses

func (p *MapToKeys) Name() string

func (*MapToKeys) Run Uses

func (p *MapToKeys) Run()

type StreamToSubStream Uses

type StreamToSubStream struct {
    scipipe.Process

    In           *scipipe.FilePort
    OutSubStream *scipipe.FilePort
    // contains filtered or unexported fields
}

StreamToSubStream takes a normal stream of InformationPacket's representing individual files, and returns one InformationPacket where the incoming IPs are sent on its substream.

func NewStreamToSubStream Uses

func NewStreamToSubStream(wf *scipipe.Workflow, name string) *StreamToSubStream

Instantiate a new StreamToSubStream

func (*StreamToSubStream) IsConnected Uses

func (p *StreamToSubStream) IsConnected() bool

func (*StreamToSubStream) Name Uses

func (p *StreamToSubStream) Name() string

func (*StreamToSubStream) Run Uses

func (p *StreamToSubStream) Run()

Run the StreamToSubStream

type StringGen Uses

type StringGen struct {
    scipipe.Process

    Strings []string
    Out     *scipipe.ParamPort
    // contains filtered or unexported fields
}

StringGen takes a number of strings and returns a generator process which sends the strings, one by one, on its `Out` port

func NewStringGen Uses

func NewStringGen(wf *scipipe.Workflow, name string, strings ...string) *StringGen

Instantiate a new StringGen

func (*StringGen) IsConnected Uses

func (proc *StringGen) IsConnected() bool

func (*StringGen) Name Uses

func (proc *StringGen) Name() string

func (*StringGen) Run Uses

func (proc *StringGen) Run()

Run the StringGen

Package components imports 6 packages (graph). Updated 2017-11-22. Refresh now. Tools for package owners.