IO::FileDescriptor
class IO::FileDescriptor
Overview
An IO over a file descriptor.
Included Modules
Direct Known Subclasses
Defined in:
io/console.crio/file_descriptor.cr
Class Method Summary
Instance Method Summary
- #blocking
- #blocking=(value)
- #close_on_exec=(arg : Bool)
- #close_on_exec?
- #closed? : Bool
- #cooked(&block)
Enable character processing for the duration of the given block.
- #cooked!
Enable character processing for this IO.
- #fcntl(cmd, arg = 0)
- #fd : Int32
- #finalize
- #inspect(io)
- #noecho(&block)
Turn off character echoing for the duration of the given block.
- #noecho!
Turn off character echoing for this IO.
- #pos
Returns the current position (in bytes) in this
IO. - #pos=(value)
Sets the current position (in bytes) in this
IO. - #pretty_print(pp)
- #raw(&block)
Enable raw mode for the duration of the given block.
- #raw!
Enable raw mode for this IO.
- #read_timeout=(read_timeout : Time::Span)
Set the number of seconds to wait when reading before raising an
IO::Timeout. - #read_timeout=(read_timeout : Nil)
Sets no timeout on read operations, so an
IO::Timeoutwill never be raised. - #read_timeout=(read_timeout : Number)
Set the number of seconds to wait when reading before raising an
IO::Timeout. - #reopen(other : IO::FileDescriptor)
- #seek(offset, whence : Seek = Seek::Set)
Seeks to a given offset (in bytes) according to the whence argument.
- #seek(offset, whence : Seek = Seek::Set, &block)
Same as
#seekbut yields to the block after seeking and eventually seeks back to the original position when the block returns. - #stat
- #tell
Same as
#pos. - #tty?
- #write_timed_out : Bool
- #write_timed_out=(write_timed_out : Bool)
- #write_timeout=(write_timeout : Number)
Set the number of seconds to wait when writing before raising an
IO::Timeout. - #write_timeout=(write_timeout : Time::Span)
Set the number of seconds to wait when writing before raising an
IO::Timeout. - #write_timeout=(write_timeout : Nil)
Sets no timeout on write operations, so an
IO::Timeoutwill never be raised.
Macro Summary
Instance methods inherited from module IO::Buffered
close : Nil close, flush flush, flush_on_newline=(flush_on_newline) flush_on_newline=, flush_on_newline? flush_on_newline?, peek : Bytes? peek, read(slice : Bytes) read, rewind rewind, sync=(sync) sync=, sync? sync?, unbuffered_close unbuffered_close, unbuffered_flush unbuffered_flush, unbuffered_read(slice : Bytes) unbuffered_read, unbuffered_rewind unbuffered_rewind, unbuffered_write(slice : Bytes) unbuffered_write, write(slice : Bytes) write Instance methods inherited from module IO
< <<, close close, closed? closed?, each_byteeach_byte(&block) : Nil 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(limit : Int, chomp = false) : String?
gets(delimiter : Char, chomp = false) : String?
gets(delimiter : String, chomp = false) : String?
gets(chomp = true) : String?
gets(delimiter : Char, limit : Int, chomp = false) : String? gets, gets_to_end : String gets_to_end, peek : Bytes? peek, print(*objects : _) : Nil
print(obj) : Nil print, printf(format_string, args : Array | Tuple) : Nil
printf(format_string, *args) : Nil printf, puts(*objects : _) : Nil
puts : Nil
puts(obj) : Nil
puts(string : String) : Nil puts, read(slice : Bytes) read, 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, set_encoding(encoding : String, invalid : Symbol? = nil) set_encoding, skip(bytes_count : Int) : Nil skip, skip_to_end : Nil skip_to_end, 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 module IO
copy(src, dst, limit : Int)copy(src, dst) copy, pipe(read_blocking = false, write_blocking = false)
pipe(read_blocking = false, write_blocking = false, &block) pipe, select(read_ios, write_ios, error_ios, timeout_sec : LibC::TimeT | Int | Float?)
select(read_ios, write_ios = nil, error_ios = nil) select
Instance methods inherited from class Reference
==(other : self)==(other) ==, dup dup, hash 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
Class 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 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
Class 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) : self from_yaml
Class Method Detail
def self.fcntl(fd, cmd, arg = 0)Source
Instance Method Detail
def blockingSource
def blocking=(value)Source
def close_on_exec?Source
def cooked(&block)Source
Enable character processing for the duration of the given block. The so called cooked mode is the standard behavior of a terminal, doing line wise editing by the terminal and only sending the input to the program on a newline. Only call this when this IO is a TTY, such as a not redirected stdin.
def cooked!Source
Enable character processing for this IO. The so called cooked mode is the standard behavior of a terminal, doing line wise editing by the terminal and only sending the input to the program on a newline. Only call this when this IO is a TTY, such as a not redirected stdin.
def fcntl(cmd, arg = 0)Source
def finalizeSource
def inspect(io)Source
def noecho(&block)Source
Turn off character echoing for the duration of the given block. This will prevent displaying back to the user what they enter on the terminal. Only call this when this IO is a TTY, such as a not redirected stdin.
print "Enter password: " password = STDIN.noecho &.gets.try &.chomp puts
def noecho!Source
Turn off character echoing for this IO. This will prevent displaying back to the user what they enter on the terminal. Only call this when this IO is a TTY, such as a not redirected stdin.
def posSource
Returns the current position (in bytes) in this IO.
File.write("testfile", "hello")
file = File.new("testfile")
file.pos # => 0
file.gets(2) # => "he"
file.pos # => 2
def pos=(value)Source
Sets the current position (in bytes) in this IO.
File.write("testfile", "hello")
file = File.new("testfile")
file.pos = 3
file.gets_to_end # => "lo"
def pretty_print(pp)Source
def raw(&block)Source
Enable raw mode for the duration of the given block. In raw mode every keypress is directly sent to the program, no interpretation is done by the terminal. Only call this when this IO is a TTY, such as a not redirected stdin.
def raw!Source
Enable raw mode for this IO. In raw mode every keypress is directly sent to the program, no interpretation is done by the terminal. Only call this when this IO is a TTY, such as a not redirected stdin.
def read_timeout=(read_timeout : Time::Span)Source
Set the number of seconds to wait when reading before raising an IO::Timeout.
def read_timeout=(read_timeout : Nil)Source
Sets no timeout on read operations, so an IO::Timeout will never be raised.
def read_timeout=(read_timeout : Number)Source
Set the number of seconds to wait when reading before raising an IO::Timeout.
def reopen(other : IO::FileDescriptor)Source
def seek(offset, whence : Seek = Seek::Set)Source
Seeks to a given offset (in bytes) according to the whence argument. Returns self.
File.write("testfile", "abc")
file = File.new("testfile")
file.gets(3) # => "abc"
file.seek(1, IO::Seek::Set)
file.gets(2) # => "bc"
file.seek(-1, IO::Seek::Current)
file.gets(1) # => "c"
def seek(offset, whence : Seek = Seek::Set, &block)Source
Same as #seek but yields to the block after seeking and eventually seeks back to the original position when the block returns.
def statSource
def tty?Source
def write_timeout=(write_timeout : Number)Source
Set the number of seconds to wait when writing before raising an IO::Timeout.
def write_timeout=(write_timeout : Time::Span)Source
Set the number of seconds to wait when writing before raising an IO::Timeout.
def write_timeout=(write_timeout : Nil)Source
Sets no timeout on write operations, so an IO::Timeout will never be raised.
Macro Detail
macro cooked_from_tc_mode!Source
macro noecho_from_tc_mode!Source
macro raw_from_tc_mode!Source
© 2012–2017 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/0.22.0/IO/FileDescriptor.html
