File: monitored_pipe.rb

package info (click to toggle)
ruby-process-executer 4.0.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 408 kB
  • sloc: ruby: 873; makefile: 4
file content (44 lines) | stat: -rw-r--r-- 1,201 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# frozen_string_literal: true

require_relative 'destination_base'

module ProcessExecuter
  module Destinations
    # Handles monitored pipes
    #
    # @api private
    class MonitoredPipe < DestinationBase
      # Writes data to the monitored pipe
      #
      # @example
      #   stringio_dest = StringIO.new
      #   pipe = ProcessExecuter::MonitoredPipe.new(stringio_dest)
      #   pipe_handler = ProcessExecuter::Destinations::MonitoredPipe.new(pipe)
      #   pipe_handler.write("Data to pipe")
      #
      # @param data [String] the data to write
      #
      # @return [Integer] the number of bytes written
      #
      def write(data)
        super
        destination.write data
      end

      # Closes the pipe if it's open
      #
      # @return [void]
      def close
        destination.close if destination.state == :open
      end

      # Determines if this class can handle the given destination
      #
      # @param destination [Object] the destination to check
      # @return [Boolean] true if destination is a ProcessExecuter::MonitoredPipe
      def self.handles?(destination)
        destination.is_a? ProcessExecuter::MonitoredPipe
      end
    end
  end
end