Class: CZMQ::FFI::ZdirPatch

Inherits:
Object
  • Object
show all
Defined in:
lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb

Overview

Note:

This class is 100% generated using zproject.

work with directory patches

Defined Under Namespace

Classes: DestroyedError

Constant Summary collapse

CREATE =

Creates a new file

1
DELETE =

Delete a file

2

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ptr, finalize = true) ⇒ ZdirPatch

Attaches the pointer ptr to this instance and defines a finalizer for it if necessary.

Parameters:

  • ptr (::FFI::Pointer)
  • finalize (Boolean) (defaults to: true) 


30
31
32
33
34
35
36
37
38
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 30

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

Class Method Details

.__new ⇒ Object 



24
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 24

alias :__new :new

.create_finalizer_for(ptr) ⇒ Proc

Parameters:

  • ptr (::FFI::Pointer)

Returns:

  • (Proc) 


41
42
43
44
45
46
47
48
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 41

def self.create_finalizer_for(ptr)
  ptr_ptr = ::FFI::MemoryPointer.new :pointer

  Proc.new do
    ptr_ptr.write_pointer ptr
    ::CZMQ::FFI.zdir_patch_destroy ptr_ptr
  end
end

.new(path, file, op, alias_) ⇒ CZMQ::ZdirPatch

Create new patch

Parameters:

  • path (String, #to_s, nil)
  • file (Zfile, #__ptr)
  • op (Integer, #to_int, #to_i)
  • alias_ (String, #to_s, nil)

Returns:

  • (CZMQ::ZdirPatch) 


89
90
91
92
93
94
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 89

def self.new(path, file, op, alias_)
  file = file.__ptr if file
  op = Integer(op)
  ptr = ::CZMQ::FFI.zdir_patch_new(path, file, op, alias_)
  __new ptr
end

.test(verbose) ⇒ void

This method returns an undefined value.

Self test of this class.

Parameters:

  • verbose (Boolean) 


183
184
185
186
187
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 183

def self.test(verbose)
  verbose = !(0==verbose||!verbose) # boolean
  result = ::CZMQ::FFI.zdir_patch_test(verbose)
  result
end

Instance Method Details

#__ptr ⇒ ::FFI::Pointer Also known as: to_ptr

Return internal pointer

Returns:

  • (::FFI::Pointer)

Raises:



55
56
57
58
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 55

def __ptr
  raise DestroyedError unless @ptr
  @ptr
end

#__ptr_give_ref ⇒ ::FFI::MemoryPointer

Note:

This detaches the current instance from the native object and thus makes it unusable.

Nullify internal pointer and return pointer pointer.

Returns:

  • (::FFI::MemoryPointer) —

    the pointer pointing to a pointer pointing to the native object

Raises:



66
67
68
69
70
71
72
73
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 66

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 ⇒ void

Note:

Only use this if you need to and can guarantee that the native object will be freed by other means.

This method returns an undefined value.

Undefines the finalizer for this object.



78
79
80
81
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 78

def __undef_finalizer
  ObjectSpace.undefine_finalizer self
  @finalizer = nil
end

#destroy ⇒ void

This method returns an undefined value.

Destroy a patch



99
100
101
102
103
104
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 99

def destroy()
  return unless @ptr
  self_p = __ptr_give_ref
  result = ::CZMQ::FFI.zdir_patch_destroy(self_p)
  result
end

#digest ⇒ String

Return hash digest for patch file

Returns:

  • (String)

Raises:



172
173
174
175
176
177
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 172

def digest()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zdir_patch_digest(self_p)
  result
end

#digest_set ⇒ void

This method returns an undefined value.

Calculate hash digest for file (create only)

Raises:



162
163
164
165
166
167
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 162

def digest_set()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zdir_patch_digest_set(self_p)
  result
end

#dup ⇒ ZdirPatch

Create copy of a patch. If the patch is null, or memory was exhausted, returns null.

Returns:

Raises:



110
111
112
113
114
115
116
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 110

def dup()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zdir_patch_dup(self_p)
  result = ZdirPatch.__new result, true
  result
end

#file ⇒ Zfile

Return patch file item

Returns:

Raises:



131
132
133
134
135
136
137
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 131

def file()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zdir_patch_file(self_p)
  result = Zfile.__new result, false
  result
end

#null? ⇒ Boolean

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 50

def null?
  !@ptr or @ptr.null?
end

#op ⇒ Integer

Return operation

Returns:

  • (Integer)

Raises:



142
143
144
145
146
147
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 142

def op()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zdir_patch_op(self_p)
  result
end

#path ⇒ String

Return patch file directory path

Returns:

  • (String)

Raises:



121
122
123
124
125
126
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 121

def path()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zdir_patch_path(self_p)
  result
end

#vpath ⇒ String

Return patch virtual file path

Returns:

  • (String)

Raises:



152
153
154
155
156
157
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb', line 152

def vpath()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zdir_patch_vpath(self_p)
  result
end