Class: Libuv::File

Inherits:
Q::DeferredPromise show all
Includes:
Assertions, FsChecks, Listener, Resource
Defined in:
lib/libuv/file.rb

Constant Summary collapse

EOF =
"0\r\n\r\n".freeze
CRLF =
"\r\n".freeze

Constants included from Assertions

Assertions::MSG_NO_PROC

Constants inherited from Q::Promise

Q::Promise::MAKE_PROMISE

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Assertions

#assert_block, #assert_boolean, #assert_type

Methods included from Resource

#check_result, #check_result!, #resolve, #to_ptr

Methods included from FsChecks

#stat

Methods inherited from Q::DeferredPromise

#resolved?, #then

Methods inherited from Q::Promise

#catch, #finally, #progress

Constructor Details

#initialize(loop, path, flags = 0, mode = 0) ⇒ File

Returns a new instance of File.



13
14
15
16
17
18
19
20
21
22
23
24
# File 'lib/libuv/file.rb', line 13

def initialize(loop, path, flags = 0, mode = 0)
    super(loop, loop.defer)

    @fileno = -1
    @closed = true 
    @path, @flags, @mode = path, flags, mode
    @request_refs = {}

    request = ::Libuv::Ext.create_request(:uv_fs)
    pre_check @defer, request, ::Libuv::Ext.fs_open(@loop, request, @path, @flags, @mode, callback(:on_open))
    nil
end

Instance Attribute Details

#closedObject (readonly)

Returns the value of attribute closed.



10
11
12
# File 'lib/libuv/file.rb', line 10

def closed
  @closed
end

#filenoObject (readonly)

Returns the value of attribute fileno.



10
11
12
# File 'lib/libuv/file.rb', line 10

def fileno
  @fileno
end

Instance Method Details

#chmod(mode) ⇒ Object



102
103
104
105
106
107
108
109
110
# File 'lib/libuv/file.rb', line 102

def chmod(mode)
    assert_type(Integer, mode, "mode must be an Integer")
    deferred = @loop.defer

    request = ::Libuv::Ext.create_request(:uv_fs)
    @request_refs[request.address] = deferred

    pre_check deferred, request, ::Libuv::Ext.fs_fchmod(@loop.handle, request, @fileno, mode, callback(:on_chmod))
end

#chown(uid, gid) ⇒ Object



112
113
114
115
116
117
118
119
120
121
# File 'lib/libuv/file.rb', line 112

def chown(uid, gid)
    assert_type(Integer, uid, "uid must be an Integer")
    assert_type(Integer, gid, "gid must be an Integer")
    deferred = @loop.defer

    request = ::Libuv::Ext.create_request(:uv_fs)
    @request_refs[request.address] = deferred

    pre_check deferred, request, ::Libuv::Ext.fs_fchown(@loop.handle, request, @fileno, uid, gid, callback(:on_chown))
end

#closeObject



26
27
28
29
30
31
# File 'lib/libuv/file.rb', line 26

def close
    @closed = true
    request = ::Libuv::Ext.create_request(:uv_fs)
    pre_check(@defer, request, ::Libuv::Ext.fs_close(@loop.handle, request, @fileno, callback(:on_close)))
    nil # pre-check returns a promise
end

#datasyncObject



72
73
74
75
76
77
78
79
# File 'lib/libuv/file.rb', line 72

def datasync
    deferred = @loop.defer

    request = ::Libuv::Ext.create_request(:uv_fs)
    @request_refs[request.address] = deferred

    pre_check deferred, request, ::Libuv::Ext.fs_fdatasync(@loop.handle, request, @fileno, callback(:on_datasync))
end

#read(length, offset = 0) ⇒ Object



33
34
35
36
37
38
39
40
41
42
43
44
45
# File 'lib/libuv/file.rb', line 33

def read(length, offset = 0)
    assert_type(Integer, length, "length must be an Integer")
    assert_type(Integer, offset, "offset must be an Integer")
    deferred = @loop.defer

    buffer1 = FFI::MemoryPointer.new(length)
    buffer  = ::Libuv::Ext.buf_init(buffer1, length)
    request = ::Libuv::Ext.create_request(:uv_fs)

    @request_refs[request.address] = [deferred, buffer1]

    pre_check(deferred, request, ::Libuv::Ext.fs_read(@loop.handle, request, @fileno, buffer, 1, offset, callback(:on_read)))
end

#send_file(stream, type = :raw, chunk_size = 4096) ⇒ Object



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/libuv/file.rb', line 123

def send_file(stream, type = :raw, chunk_size = 4096)
    @transmit_failure ||= method(:transmit_failure)
    @transmit_data ||= method(:transmit_data)
    @start_transmit ||= method(:start_transmit)
    @next_chunk ||= method(:next_chunk)

    @sending_file = @loop.defer
    @file_stream = stream
    @file_stream_type = type
    @file_chunk_size = chunk_size
    @file_chunk_count = 0

    stat.then @start_transmit, @transmit_failure
    
    @sending_file.promise.finally &method(:clean_up_send)
end

#syncObject



63
64
65
66
67
68
69
70
# File 'lib/libuv/file.rb', line 63

def sync
    deferred = @loop.defer

    request = ::Libuv::Ext.create_request(:uv_fs)
    @request_refs[request.address] = deferred

    pre_check deferred, request, ::Libuv::Ext.fs_fsync(@loop.handle, request, @fileno, callback(:on_sync))
end

#truncate(offset) ⇒ Object



81
82
83
84
85
86
87
88
89
# File 'lib/libuv/file.rb', line 81

def truncate(offset)
    assert_type(Integer, offset, "offset must be an Integer")
    deferred = @loop.defer

    request = ::Libuv::Ext.create_request(:uv_fs)
    @request_refs[request.address] = deferred

    pre_check deferred, request, ::Libuv::Ext.fs_ftruncate(@loop.handle, request, @fileno, offset, callback(:on_truncate))
end

#utime(atime, mtime) ⇒ Object



91
92
93
94
95
96
97
98
99
100
# File 'lib/libuv/file.rb', line 91

def utime(atime, mtime)
    assert_type(Integer, atime, "atime must be an Integer")
    assert_type(Integer, mtime, "mtime must be an Integer")
    deferred = @loop.defer

    request = ::Libuv::Ext.create_request(:uv_fs)
    @request_refs[request.address] = deferred

    pre_check deferred, request, ::Libuv::Ext.fs_futime(@loop.handle, request, @fileno, atime, mtime, callback(:on_utime))
end

#write(data, offset = 0) ⇒ Object



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/libuv/file.rb', line 47

def write(data, offset = 0)
    assert_type(String, data, "data must be a String")
    assert_type(Integer, offset, "offset must be an Integer")
    deferred = @loop.defer

    length = data.respond_to?(:bytesize) ? data.bytesize : data.size

    buffer1 = FFI::MemoryPointer.from_string(data)
    buffer  = ::Libuv::Ext.buf_init(buffer1, length)
    request = ::Libuv::Ext.create_request(:uv_fs)

    @request_refs[request.address] = [deferred, buffer1]

    pre_check(deferred, request, ::Libuv::Ext.fs_write(@loop.handle, request, @fileno, buffer, 1, offset, callback(:on_write)))
end