class IO::FileDescriptor

Overview

An IO over a file descriptor.

Included Modules

Direct Known Subclasses

Defined in:

io/file_descriptor.cr

Class Method Summary

Instance Method 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, cooked(&block) cooked, cooked! cooked!, each_byte
each_byte(&block)
each_byte
, each_char(&block)
each_char
each_char
, each_line(*args, &block)
each_line(*args)
each_line
, 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(*objects : _) : Nil
print(obj) : Nil
print
, printf(format_string, args : Array | Tuple) : Nil
printf(format_string, *args) : Nil
printf
, puts : Nil
puts(*objects : _) : Nil
puts(string : String) : Nil
puts(obj) : Nil
puts
, raw(&block) raw, raw! raw!, read(slice : Slice(UInt8)) read, read_byte : UInt8 | Nil read_byte, read_bytes(type, format = IO::ByteFormat::SystemEndian : IO::ByteFormat) read_bytes, read_char : Char | Nil read_char, read_fully(slice : Slice(UInt8)) read_fully, read_line(*args) : String | Nil read_line, read_nonblock(size) read_nonblock, 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::SystemEndian : IO::ByteFormat) write_bytes

Class methods inherited from module IO

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)
==
, hash hash, inspect(io : IO) : Nil inspect, nil? nil?, object_id object_id, same?(other : Nil)
same?(other : Reference)
same?
, to_s(io : IO) : Nil to_s

Instance methods inherited from class Object

! !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other) ===, =~(other) =~, class class, clone clone, crystal_type_id crystal_type_id, dup dup, hash hash, inspect
inspect(io : IO)
inspect
, itself itself, not_nil! not_nil!, tap(&block) tap, to_json to_json, to_pretty_json(io : IO)
to_pretty_json
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

==(other : Class) ==, ===(other) ===, cast(other) : self cast, from_json(string_or_io) from_json, from_yaml(string : String) from_yaml, hash hash, inspect(io) inspect, name : String name, to_s(io) to_s

Class Method Detail

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

[View source]
def self.new(fd, 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? #

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

[View source]
def fd #

[View source]
def finalize #

[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 read_timed_out #

def read_timed_out=(read_timed_out) #

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 : Time::Span) #

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::Set : Seek) #

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 to_fd_io #

[View source]
def tty? #

[View source]
def write_timed_out #

def write_timed_out=(write_timed_out) #

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 : Time::Span) #

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]