class IO::Stapled
Overview
This class staples together two unidirectional IO
s to form a single,
bidirectional IO
.
Example (loopback):
io = IO::Stapled.new(*IO.pipe)
io.puts "linus"
io.gets # => "linus"
Most methods simply delegate to the underlying IO
s.
Defined in:
io/stapled.crConstructors
-
.new(reader : IO, writer : IO, sync_close : Bool = false)
Creates a new
IO::Stapled
which reads from reader and writes to writer-
Class Method Summary
-
.pipe(read_blocking : Bool = false, write_blocking : Bool = false, &block)
Creates a pair of bidirectional pipe endpoints connected with each other and passes them to the given block.
-
.pipe(read_blocking : Bool = false, write_blocking : Bool = false) : Tuple(self, self)
Creates a pair of bidirectional pipe endpoints connected with each other and returns them in a
Tuple
.
Instance Method Summary
-
#close : Nil
Closes this ÌO`.
-
#closed? : Bool
Returns
true
if thisIO
is closed. -
#flush : self
`Flushes
writer
. -
#gets(delimiter : Char, limit : Int, chomp = false) : String?
Gets a string from
reader
. -
#peek : Bytes?
Peeks into reader.
-
#read(slice : Bytes)
Reads a slice from
reader
. -
#read_byte : UInt8?
Reads a single byte from
reader
. -
#skip(bytes_count : Int) : Nil
Skips
reader
. -
#sync_close=(sync_close : Bool)
If
#sync_close?
istrue
, closing thisIO
will close the underlyingIO
s. -
#sync_close? : Bool
If
#sync_close?
istrue
, closing thisIO
will close the underlyingIO
s. -
#write(slice : Bytes) : Nil
Writes a slice to
writer
. -
#write_byte(byte : UInt8) : Nil
Writes a byte to
writer
.
Instance methods inherited from class IO
<<(obj) : self
<<,
close
close,
closed?
closed?,
each_byte(&block) : Nileach_byte each_byte, each_char(&block) : Nil
each_char each_char, each_line(*args, **options, &block) : Nil
each_line(*args, **options) each_line, encoding : String encoding, flush flush, gets(delimiter : Char, limit : Int, chomp = false) : String?
gets(delimiter : Char, chomp = false) : String?
gets(chomp = true) : String?
gets(limit : Int, chomp = false) : String?
gets(delimiter : String, chomp = false) : String? gets, gets_to_end : String gets_to_end, peek : Bytes? peek, pos pos, pos=(value) pos=, print(*objects : _) : Nil
print(obj) : Nil print, printf(format_string, *args) : Nil
printf(format_string, args : Array | Tuple) : Nil printf, puts(*objects : _) : Nil
puts : Nil
puts(obj) : Nil
puts(string : String) : Nil puts, read(slice : Bytes) read, read_at(offset, bytesize, &block) read_at, read_byte : UInt8? read_byte, read_bytes(type, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) read_bytes, read_char : Char? read_char, read_fully(slice : Bytes) read_fully, read_fully?(slice : Bytes) read_fully?, read_line(*args, **options) : String read_line, read_string(bytesize : Int) : String read_string, read_utf8(slice : Bytes) read_utf8, read_utf8_byte read_utf8_byte, rewind rewind, seek(offset, whence : Seek = Seek::Set) seek, set_encoding(encoding : String, invalid : Symbol? = nil) set_encoding, skip(bytes_count : Int) : Nil skip, skip_to_end : Nil skip_to_end, tell tell, tty? : Bool tty?, write(slice : Bytes) : Nil write, write_byte(byte : UInt8) write_byte, write_bytes(object, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) write_bytes, write_utf8(slice : Bytes) write_utf8
Class methods inherited from class IO
copy(src, dst, limit : Int)copy(src, dst) copy, pipe(read_blocking = false, write_blocking = false) : Tuple(IO::FileDescriptor, IO::FileDescriptor)
pipe(read_blocking = false, write_blocking = false, &block) pipe
Instance methods inherited from class Reference
==(other : self)==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference)
same?(other : Nil) same?, to_s(io : IO) : Nil to_s
Constructor methods inherited from class Reference
new
new
Instance methods inherited from class Object
!=(other)
!=,
!~(other)
!~,
==(other)
==,
===(other : JSON::Any)===(other : YAML::Any)
===(other) ===, =~(other) =~, class class, dup dup, hash(hasher)
hash hash, inspect(io : IO)
inspect inspect, itself itself, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, tap(&block) tap, to_json(io : IO)
to_json to_json, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ") to_pretty_json, to_s
to_s(io : IO) to_s, to_yaml(io : IO)
to_yaml to_yaml, try(&block) try, unsafe_as(type : T.class) forall T unsafe_as
Constructor methods inherited from class Object
from_json(string_or_io, root : String) : selffrom_json(string_or_io) : self from_json, from_yaml(string_or_io : String | IO) : self from_yaml
Constructor Detail
Creates a new IO::Stapled
which reads from reader and writes to writer-
Class Method Detail
Creates a pair of bidirectional pipe endpoints connected with each other and passes them to the given block.
Both endpoints and the underlying ÌO`s are closed after the block
(even if #sync_close?
is false
).
Creates a pair of bidirectional pipe endpoints connected with each other
and returns them in a Tuple
.
Instance Method Detail
Closes this ÌO`.
If #sync_close?
is true
it will also close the underlying ÌO`s.
Returns true
if this IO
is closed.
Underlying ÌO`s might have a different status.
Gets a string from reader
.
If #sync_close?
is true
, closing this IO
will close the underlying IO
s.
If #sync_close?
is true
, closing this IO
will close the underlying IO
s.