I/O - Plugin operators

This page lists all operators available in the stdio sub-package of ro.

Help improve this documentation

This documentation is still new and evolving. If you spot any mistakes, unclear explanations, or missing details, please open an issue.

Your feedback helps us improve!

Install

First, import the sub-package in your project:

go get -u github.com/samber/ro/plugins/stdio

• NewIOReader

  stdioplugin

  🧩 Source📚 GoDoc🎮 Try on Go Playground

  Creates an observable that reads data from an io.Reader in chunks.

  import (
      "io"
      "strings"
  
      "github.com/samber/ro"
      rostdio "github.com/samber/ro/plugins/stdio"
  )
  
  data := strings.NewReader("Hello, World!")
  obs := rostdio.NewIOReader(data)
  
  sub := obs.Subscribe(ro.PrintObserver[[]byte]())
  defer sub.Unsubscribe()
  
  // Next: [72 101 108 108 111 44 32 87 111 114 108 100 33]
  // Completed

  Variant:

  io› newioreader

  Similar:

  io› newioreaderlineio› newstdreader

  Prototype:

  func NewIOReader(reader io.Reader)

• NewPrompt

  stdioplugin

  🧩 Source📚 GoDoc

  Creates an observable that prompts the user for input.

  import (
      "github.com/samber/ro"
      rostdio "github.com/samber/ro/plugins/stdio"
  )
  
  obs := rostdio.NewPrompt("Enter your name: ")
  
  sub := obs.Subscribe(ro.NewObserver(
      func(input []byte) {
          println("You entered:", string(input))
      },
      func(err error) {
          println("Error:", err.Error())
      },
      func() {
          println("Input completed")
      },
  ))
  defer sub.Unsubscribe()
  
  // (User sees prompt: "Enter your name: ")
  // User types: "Alice"
  // You entered: Alice

  Variant:

  io› newprompt

  Similar:

  io› newstdreaderio› newstdreaderline

  Prototype:

  func NewPrompt(prompt string)

• NewIOReaderLine

  stdioplugin

  🧩 Source📚 GoDoc🎮 Try on Go Playground

  Creates an observable that reads lines from an io.Reader.

  import (
      "strings"
  
      "github.com/samber/ro"
      rostdio "github.com/samber/ro/plugins/stdio"
  )
  
  data := strings.NewReader("line1\nline2\nline3")
  obs := rostdio.NewIOReaderLine(data)
  
  sub := obs.Subscribe(ro.PrintObserver[[]byte]())
  defer sub.Unsubscribe()
  
  // Next: [108 105 110 101 49]
  // Next: [108 105 110 101 50]
  // Next: [108 105 110 101 51]
  // Completed

  Variant:

  io› newioreaderline

  Similar:

  io› newioreaderio› newstdreaderline

  Prototype:

  func NewIOReaderLine(reader io.Reader)

• NewStdReader

  stdioplugin

  🧩 Source📚 GoDoc🎮 Try on Go Playground

  Creates an observable that reads data from standard input.

  import (
      "github.com/samber/ro"
      rostdio "github.com/samber/ro/plugins/stdio"
  )
  
  obs := rostdio.NewStdReader()
  
  sub := obs.Subscribe(ro.PrintObserver[[]byte]())
  defer sub.Unsubscribe()
  
  // Reads from stdin when data is available
  // Next: [104 101 108 108 111]  // if user types "hello"
  // Completed

  Variant:

  io› newstdreader

  Similar:

  io› newioreaderio› newstdreaderline

  Prototype:

  func NewStdReader()

• NewStdReaderLine

  stdioplugin

  🧩 Source📚 GoDoc

  Creates an observable that reads lines from standard input.

  import (
      "github.com/samber/ro"
      rostdio "github.com/samber/ro/plugins/stdio"
  )
  
  obs := rostdio.NewStdReaderLine()
  
  sub := obs.Subscribe(ro.PrintObserver[[]byte]())
  defer sub.Unsubscribe()
  
  // Reads lines from stdin when user enters data
  // Next: [104 101 108 108 111]  // if user types "hello"
  // Completed

  Variant:

  io› newstdreaderline

  Similar:

  io› newioreaderlineio› newstdreader

  Prototype:

  func NewStdReaderLine()

• NewIOWriter

  stdioplugin

  🧩 Source📚 GoDoc🎮 Try on Go Playground

  Creates an operator that writes byte arrays to an io.Writer and returns the count of written bytes.

  import (
      "bytes"
  
      "github.com/samber/ro"
      rostdio "github.com/samber/ro/plugins/stdio"
  )
  
  var buf bytes.Buffer
  obs := ro.Pipe[[]byte, int](
      ro.Just([]byte("Hello, "), []byte("World!")),
      rostdio.NewIOWriter(&buf),
  )
  
  sub := obs.Subscribe(ro.PrintObserver[int]())
  defer sub.Unsubscribe()
  
  // Next: 13
  // Completed

  Variant:

  io› newiowriter

  Similar:

  io› newstdwriter

  Prototype:

  func NewIOWriter(writer io.Writer)

• NewStdWriter

  stdioplugin

  🧩 Source📚 GoDoc🎮 Try on Go Playground

  Creates an operator that writes byte arrays to standard output and returns the count of written bytes.

  import (
      "github.com/samber/ro"
      rostdio "github.com/samber/ro/plugins/stdio"
  )
  
  obs := ro.Pipe[[]byte, int](
      ro.Just([]byte("Hello, World!")),
      rostdio.NewStdWriter(),
  )
  
  sub := obs.Subscribe(ro.PrintObserver[int]())
  defer sub.Unsubscribe()
  
  // Hello, World! (written to stdout)
  // Next: 13
  // Completed

  Variant:

  io› newstdwriter

  Similar:

  io› newiowriter

  Prototype:

  func NewStdWriter()