module Cinch::DCC::DCCableObject
This module describes the required interface for objects that should be sendable via DCC
.
@note `File` conforms to this interface. @since 2.0.0 @abstract
Public Instance Methods
path()
click to toggle source
@return [String] A string representing the object's path or name.
@note This is only required if calling {User#dcc_send} with only
one argument
# File lib/cinch/dcc/dccable_object.rb, line 29 def path; end
read(number)
click to toggle source
Return the next `number` bytes of the object.
@param [Integer] number Read `number` bytes at most @return [String] The read data @return [nil] If no more data can be read
# File lib/cinch/dcc/dccable_object.rb, line 17 def read(number); end
seek(position)
click to toggle source
Seek to a specific position.
@param [Integer] position The position in bytes to seek to @return [void]
# File lib/cinch/dcc/dccable_object.rb, line 23 def seek(position); end
size()
click to toggle source
@return [Integer] The total size of the data, in bytes.
# File lib/cinch/dcc/dccable_object.rb, line 32 def size; end