Class: Libvirt::StorageVolume

Inherits:

Object

• Object
• Libvirt::StorageVolume

show all

Defined in:

lib/libvirt/storage_volume.rb

Overview

Instance Method Summary (collapse)

• - (Boolean) ==(other)

  Provide a meaningful equality check so that two storage volumes can eaisly be checked for equality.

• - (Integer) allocation

  Returns the currently allocated number of bytes.

• - (Integer) capacity

  Returns the capacity of this volume in bytes.

• - (Boolean) delete

  Delete the storage volume rom the pool.

• - (StorageVolume) initialize(pointer) constructor

  Initializes a new StorageVolume object given a virStorageVolPtr.

• - (String) key (also: #uuid)

  Returns a key for this storage volume.

• - (String) name

  Returns the name of this storage volume.

• - (String) path

  Returns the path of this storage volume.

• - (FFI::Pointer) to_ptr

  Returns the actual virStorageVolPtr underlying this structure.

• - (Symbol) type

  Returns the type of this storage volume.

• - (Boolean) wipe

  Wipe the contents of a volume so it is not readable in the future.

• - (String) xml

  Returns the XML description of this storage volume.

7
8
9
10

# File 'lib/libvirt/storage_volume.rb', line 7

def initialize(pointer)
  @pointer = pointer
  ObjectSpace.define_finalizer(self, method(:finalize))
end

87
88
89

# File 'lib/libvirt/storage_volume.rb', line 87

def ==(other)
  other.is_a?(StorageVolume) && other.uuid == uuid
end

51
52
53

# File 'lib/libvirt/storage_volume.rb', line 51

def allocation
  info[:allocation]
end

44
45
46

# File 'lib/libvirt/storage_volume.rb', line 44

def capacity
  info[:capacity]
end

65
66
67

# File 'lib/libvirt/storage_volume.rb', line 65

def delete
  FFI::Libvirt.virStorageVolDelete(self, 0) == 0
end

15
16
17

# File 'lib/libvirt/storage_volume.rb', line 15

def key
  FFI::Libvirt.virStorageVolGetKey(self)
end

23
24
25

# File 'lib/libvirt/storage_volume.rb', line 23

def name
  FFI::Libvirt.virStorageVolGetName(self)
end

30
31
32

# File 'lib/libvirt/storage_volume.rb', line 30

def path
  FFI::Libvirt.virStorageVolGetPath(self)
end

79
80
81

# File 'lib/libvirt/storage_volume.rb', line 79

def to_ptr
  @pointer
end

37
38
39

# File 'lib/libvirt/storage_volume.rb', line 37

def type
  info[:type]
end

58
59
60

# File 'lib/libvirt/storage_volume.rb', line 58

def wipe
  FFI::Libvirt.virStorageVolWipe(self, 0) == 0
end

72
73
74

# File 'lib/libvirt/storage_volume.rb', line 72

def xml
  FFI::Libvirt.virStorageVolGetXMLDesc(self, 0)
end