class CZMQ::FFI::Zfile

helper functions for working with files. @note This class is 100% generated using zproject.

Public Class Methods

__new(path, name)
Alias for: new
create_finalizer_for(ptr) click to toggle source

@param ptr [::FFI::Pointer] @return [Proc]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 35
def self.create_finalizer_for(ptr)
  Proc.new do
    ptr_ptr = ::FFI::MemoryPointer.new :pointer
    ptr_ptr.write_pointer ptr
    ::CZMQ::FFI.zfile_destroy ptr_ptr
  end
end
new(ptr, finalize = true) click to toggle source

Attaches the pointer ptr to this instance and defines a finalizer for it if necessary. @param ptr [::FFI::Pointer] @param finalize [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 24
def initialize(ptr, finalize = true)
  @ptr = ptr
  if @ptr.null?
    @ptr = nil # Remove null pointers so we don't have to test for them.
  elsif finalize
    @finalizer = self.class.create_finalizer_for @ptr
    ObjectSpace.define_finalizer self, @finalizer
  end
end
new(path, name) click to toggle source

If file exists, populates properties. CZMQ supports portable symbolic links, which are files with the extension “.ln”. A symbolic link is a text file containing one line, the filename of a target file. Reading data from the symbolic link actually reads from the target file. Path may be NULL, in which case it is not used. @param path [String, to_s, nil] @param name [String, to_s, nil] @return [CZMQ::Zfile]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 84
def self.new(path, name)
  ptr = ::CZMQ::FFI.zfile_new(path, name)
  __new ptr
end
Also aliased as: __new
test(verbose) click to toggle source

Self test of this class.

@param verbose [Boolean] @return [void]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 349
def self.test(verbose)
  verbose = !(0==verbose||!verbose) # boolean
  result = ::CZMQ::FFI.zfile_test(verbose)
  result
end
tmp() click to toggle source

Create new temporary file for writing via tmpfile. File is automatically deleted on destroy @return [CZMQ::Zfile]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 92
def self.tmp()
  ptr = ::CZMQ::FFI.zfile_tmp()
  __new ptr
end

Public Instance Methods

__ptr() click to toggle source

Return internal pointer @return [::FFI::Pointer]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 48
def __ptr
  raise DestroyedError unless @ptr
  @ptr
end
Also aliased as: to_ptr
__ptr_give_ref() click to toggle source

Nullify internal pointer and return pointer pointer. @note This detaches the current instance from the native object

and thus makes it unusable.

@return [::FFI::MemoryPointer] the pointer pointing to a pointer

pointing to the native object
# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 59
def __ptr_give_ref
  raise DestroyedError unless @ptr
  ptr_ptr = ::FFI::MemoryPointer.new :pointer
  ptr_ptr.write_pointer @ptr
  __undef_finalizer if @finalizer
  @ptr = nil
  ptr_ptr
end
__undef_finalizer() click to toggle source

Undefines the finalizer for this object. @note Only use this if you need to and can guarantee that the native

object will be freed by other means.

@return [void]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 71
def __undef_finalizer
  ObjectSpace.undefine_finalizer self
  @finalizer = nil
end
close() click to toggle source

Close file, if open

@return [void]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 318
def close()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_close(self_p)
  result
end
cursize() click to toggle source

Return the last-known size of the file. If you want this to reflect the current situation, call zfile_restat before checking this property.

@return [::FFI::Pointer]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 157
def cursize()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_cursize(self_p)
  result
end
destroy() click to toggle source

Destroy a file item

@return [void]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 100
def destroy()
  return unless @ptr
  self_p = __ptr_give_ref
  result = ::CZMQ::FFI.zfile_destroy(self_p)
  result
end
digest() click to toggle source

Calculate SHA1 digest for file, using zdigest class.

@return [String]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 338
def digest()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_digest(self_p)
  result
end
dup() click to toggle source

Duplicate a file item, returns a newly constructed item. If the file is null, or memory was exhausted, returns null.

@return [Zfile]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 111
def dup()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_dup(self_p)
  result = Zfile.__new result, true
  result
end
eof() click to toggle source

Returns true if zfile_read() just read the last chunk in the file.

@return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 283
def eof()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_eof(self_p)
  result
end
filename(path) click to toggle source

Return file name, remove path if provided

@param path [String, to_s, nil] @return [String]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 123
def filename(path)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_filename(self_p, path)
  result
end
handle() click to toggle source

Return file handle, if opened

@return [::FFI::Pointer]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 328
def handle()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_handle(self_p)
  result
end
has_changed() click to toggle source

Return true if the file was changed on disk since the zfile_t object was created, or the last zfile_restat() call made on it.

@return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 225
def has_changed()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_has_changed(self_p)
  result
end
input() click to toggle source

Open file for reading Returns 0 if OK, -1 if not found or not accessible

@return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 246
def input()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_input(self_p)
  result
end
is_directory() click to toggle source

Return true if the file is a directory. If you want this to reflect any external changes, call zfile_restat before checking this property.

@return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 168
def is_directory()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_is_directory(self_p)
  result
end
is_readable() click to toggle source

Return true if the file is readable by this process. If you want this to reflect any external changes, call zfile_restat before checking this property.

@return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 191
def is_readable()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_is_readable(self_p)
  result
end
is_regular() click to toggle source

Return true if the file is a regular file. If you want this to reflect any external changes, call zfile_restat before checking this property.

@return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 179
def is_regular()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_is_regular(self_p)
  result
end
is_stable() click to toggle source

Check if file has stopped changing and can be safely processed. Updates the file statistics from disk at every call.

@return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 214
def is_stable()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_is_stable(self_p)
  result
end
is_writeable() click to toggle source

Return true if the file is writeable by this process. If you want this to reflect any external changes, call zfile_restat before checking this property.

@return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 203
def is_writeable()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_is_writeable(self_p)
  result
end
modified() click to toggle source

Return when the file was last modified. If you want this to reflect the current situation, call zfile_restat before checking this property.

@return [::FFI::Pointer]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 146
def modified()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_modified(self_p)
  result
end
null?() click to toggle source

@return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 43
def null?
  !@ptr or @ptr.null?
end
output() click to toggle source

Open file for writing, creating directory if needed File is created if necessary; chunks can be written to file at any location. Returns 0 if OK, -1 if error.

@return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 258
def output()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_output(self_p)
  result
end
read(bytes, offset) click to toggle source

Read chunk from file at specified position. If this was the last chunk, sets the eof property. Returns a null chunk in case of error.

@param bytes [Integer, to_int, to_i] @param offset [::FFI::Pointer, to_ptr] @return [Zchunk]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 271
def read(bytes, offset)
  raise DestroyedError unless @ptr
  self_p = @ptr
  bytes = Integer(bytes)
  result = ::CZMQ::FFI.zfile_read(self_p, bytes, offset)
  result = Zchunk.__new result, true
  result
end
readln() click to toggle source

Read next line of text from file. Returns a pointer to the text line, or NULL if there was nothing more to read from the file.

@return [String]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 308
def readln()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_readln(self_p)
  result
end
remove() click to toggle source

Remove the file from disk

@return [void]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 235
def remove()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_remove(self_p)
  result
end
restat() click to toggle source

Refresh file properties from disk; this is not done automatically on access methods, otherwise it is not possible to compare directory snapshots.

@return [void]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 135
def restat()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zfile_restat(self_p)
  result
end
to_ptr()

So external Libraries can just pass the Object to a FFI function which expects a :pointer

Alias for: __ptr
write(chunk, offset) click to toggle source

Write chunk to file at specified position Return 0 if OK, else -1

@param chunk [Zchunk, #__ptr] @param offset [::FFI::Pointer, to_ptr] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zfile.rb, line 296
def write(chunk, offset)
  raise DestroyedError unless @ptr
  self_p = @ptr
  chunk = chunk.__ptr if chunk
  result = ::CZMQ::FFI.zfile_write(self_p, chunk, offset)
  result
end