class IO::FileDescriptor

Overview

An IO over a file descriptor.

Included Modules

Direct Known Subclasses

Defined in:

io/console.cr
io/file_descriptor.cr

Class Method Summary

Instance Method Summary

Macro Summary

Instance methods inherited from module IO::Buffered

close close, flush flush, flush_on_newline=(flush_on_newline) flush_on_newline=, flush_on_newline? flush_on_newline?, read(slice : Slice(UInt8)) read, rewind rewind, sync=(sync) sync=, sync? sync?, unbuffered_close unbuffered_close, unbuffered_flush unbuffered_flush, unbuffered_read(slice : Slice(UInt8)) unbuffered_read, unbuffered_rewind unbuffered_rewind, unbuffered_write(slice : Slice(UInt8)) unbuffered_write, write(slice : Slice(UInt8)) write

Instance methods inherited from module IO

<<(obj) : self <<, close close, closed? closed?, each_byte(&block)
each_byte
each_byte
, each_char(&block)
each_char
each_char
, each_line(*args, **options)
each_line(*args, **options, &block)
each_line
, encoding : String encoding, flush flush, gets(limit : Int) : String | Nil
gets(delimiter : Char, limit : Int) : String | Nil
gets(delimiter : Char) : String | Nil
gets : String | Nil
gets(delimiter : String) : String | Nil
gets
, gets_to_end : String gets_to_end, print(obj) : Nil
print(*objects : _) : Nil
print
, printf(format_string, *args) : Nil
printf(format_string, args : Array | Tuple) : Nil
printf
, puts(*objects : _) : Nil
puts : Nil
puts(string : String) : Nil
puts(obj) : Nil
puts
, read(slice : Slice(UInt8)) read, read_byte : UInt8 | Nil read_byte, read_bytes(type, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) read_bytes, read_char : Char | Nil read_char, read_fully(slice : Slice(UInt8)) read_fully, read_line(*args, **options) : String | Nil read_line, read_utf8(slice : Slice(UInt8)) read_utf8, read_utf8_byte read_utf8_byte, rewind rewind, set_encoding(encoding : String, invalid : Symbol | Nil = nil) set_encoding, skip(bytes_count : Int) : Nil skip, tty? : Bool tty?, write(slice : Slice(UInt8)) : Nil write, write_byte(byte : UInt8) write_byte, write_bytes(object, format : IO::ByteFormat = IO::ByteFormat::SystemEndian) write_bytes, write_utf8(slice : Slice(UInt8)) write_utf8

Class methods inherited from module IO

copy(src, dst, limit : Int)
copy(src, dst)
copy
, pipe(read_blocking = false, write_blocking = false, &block)
pipe(read_blocking = false, write_blocking = false)
pipe
, select(read_ios, write_ios, error_ios, timeout_sec : LibC::TimeT | Int | Float | Nil)
select(read_ios, write_ios = nil, error_ios = nil)
select

Instance methods inherited from module JSON::Builder

json_array(&block) json_array, json_object(&block) json_object

Instance methods inherited from class Reference

==(other)
==(other : self)
==
, dup dup, hash hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, same?(other : Reference)
same?(other : Nil)
same?
, to_s(io : IO) : Nil to_s

Instance methods inherited from class Object

!=(other) !=, !~(other) !~, ==(other) ==, ===(other)
===(other : YAML::Any)
===(other : JSON::Any)
===
, =~(other) =~, class class, crystal_type_id crystal_type_id, dup dup, hash hash, inspect(io : IO)
inspect
inspect
, itself itself, not_nil! not_nil!, tap(&block) tap, 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
to_yaml(io : IO)
to_yaml
, try(&block) try

Class methods inherited from class Object

==(other : Class) ==, ===(other) ===, cast(other) : self cast, clone clone, dup dup, from_json(string_or_io) : self
from_json(string_or_io, root : String) : self
from_json
, from_yaml(string : String) : self from_yaml, hash hash, inspect(io) inspect, name : String name, nilable? nilable?, to_s(io) to_s, |(other : U.class) forall U |

Class Method Detail

def self.fcntl(fd, cmd, arg = 0) #

[View source]
def self.new(fd : Int32, blocking = false, edge_triggerable = false) #

[View source]

Instance Method Detail

def blocking #

[View source]
def blocking=(value) #

[View source]
def close_on_exec=(arg : Bool) #

[View source]
def close_on_exec? #

[View source]
def closed? : Bool #

[View source]
def cooked(&block) #

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.


[View source]
def cooked! #

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.


[View source]
def fcntl(cmd, arg = 0) #

[View source]
def fd : Int32 #

[View source]
def finalize #

[View source]
def inspect(io) #

[View source]
def noecho(&block) #

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

[View source]
def noecho! #

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.


[View source]
def pos #

Returns the current position (in bytes) in this IO.

io = MemoryIO.new "hello"
io.pos     # => 0
io.gets(2) # => "he"
io.pos     # => 2

[View source]
def pos=(value) #

Sets the current position (in bytes) in this IO.

io = MemoryIO.new "hello"
io.pos = 3
io.gets_to_end # => "lo"

[View source]
def raw(&block) #

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.


[View source]
def raw! #

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.


[View source]
def read_timeout=(read_timeout : Time::Span) #

Set the number of seconds to wait when reading before raising an IO::Timeout.


[View source]
def read_timeout=(read_timeout : Number) #

Set the number of seconds to wait when reading before raising an IO::Timeout.


[View source]
def read_timeout=(read_timeout : Nil) #

Sets no timeout on read operations, so an IO::Timeout will never be raised.


[View source]
def reopen(other : IO::FileDescriptor) #

[View source]
def seek(offset, whence : Seek = Seek::Set) #

Seeks to a given offset (in bytes) according to the whence argument. Returns self.

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"

[View source]
def stat #

[View source]
def tell #

Same as #pos.


[View source]
def tty? #

[View source]
def write_timed_out : Bool #

[View source]
def write_timed_out=(write_timed_out : Bool) #

[View source]
def write_timeout=(write_timeout : Number) #

Set the number of seconds to wait when writing before raising an IO::Timeout.


[View source]
def write_timeout=(write_timeout : Nil) #

Sets no timeout on write operations, so an IO::Timeout will never be raised.


[View source]
def write_timeout=(write_timeout : Time::Span) #

Set the number of seconds to wait when writing before raising an IO::Timeout.


[View source]

Macro Detail

macro cooked_from_tc_mode! #

[View source]
macro noecho_from_tc_mode! #

[View source]
macro raw_from_tc_mode! #

[View source]