Class: Comet::Partition

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/partition.rb

Overview

Partition is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Partition

Returns a new instance of Partition.



64
65
66
 
# File 'lib/comet/models/partition.rb', line 64

def initialize
  clear
end

Instance Attribute Details

#bytes_per_filesystem_cluster ⇒ Object

Returns the value of attribute bytes_per_filesystem_cluster.



59
60
61
 
# File 'lib/comet/models/partition.rb', line 59

def bytes_per_filesystem_cluster
  @bytes_per_filesystem_cluster
end

#device_name ⇒ Object

Returns the value of attribute device_name.



16
17
18
 
# File 'lib/comet/models/partition.rb', line 16

def device_name
  @device_name
end

#filesystem ⇒ Object

The name of the filesystem used on this partition (e.g. “NTFS”)



28
29
30
 
# File 'lib/comet/models/partition.rb', line 28

def filesystem
  @filesystem
end

#flags ⇒ Object

Returns the value of attribute flags.



56
57
58
 
# File 'lib/comet/models/partition.rb', line 56

def flags
  @flags
end

#mount_points ⇒ Object

Returns the value of attribute mount_points.



40
41
42
 
# File 'lib/comet/models/partition.rb', line 40

def mount_points
  @mount_points
end

#partition_guid ⇒ Object

The partition’s MBR or GPT id, if any



20
21
22
 
# File 'lib/comet/models/partition.rb', line 20

def partition_guid
  @partition_guid
end

#partition_offset ⇒ Object

The partition’s offset within the physical disk



24
25
26
 
# File 'lib/comet/models/partition.rb', line 24

def partition_offset
  @partition_offset
end

#read_offset ⇒ Object

Bytes. The partition’s offset within the DeviceName. It will be zero if this partition has a direct DeviceName handle.



45
46
47
 
# File 'lib/comet/models/partition.rb', line 45

def read_offset
  @read_offset
end

#size ⇒ Object

Bytes



49
50
51
 
# File 'lib/comet/models/partition.rb', line 49

def size
  @size
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



62
63
64
 
# File 'lib/comet/models/partition.rb', line 62

def unknown_json_fields
  @unknown_json_fields
end

#used_size ⇒ Object

Bytes. Only present for supported filesystems that are currently mounted by the OS



53
54
55
 
# File 'lib/comet/models/partition.rb', line 53

def used_size
  @used_size
end

#volume_guid ⇒ Object

Returns the value of attribute volume_guid.



34
35
36
 
# File 'lib/comet/models/partition.rb', line 34

def volume_guid
  @volume_guid
end

#volume_name ⇒ Object

Returns the value of attribute volume_name.



31
32
33
 
# File 'lib/comet/models/partition.rb', line 31

def volume_name
  @volume_name
end

#volume_serial ⇒ Object

Returns the value of attribute volume_serial.



37
38
39
 
# File 'lib/comet/models/partition.rb', line 37

def volume_serial
  @volume_serial
end

Instance Method Details

#clear ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/comet/models/partition.rb', line 68

def clear
  @device_name = ''
  @partition_guid = ''
  @partition_offset = 0
  @filesystem = ''
  @volume_name = ''
  @volume_guid = ''
  @volume_serial = ''
  @mount_points = []
  @read_offset = 0
  @size = 0
  @used_size = 0
  @flags = 0
  @bytes_per_filesystem_cluster = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/comet/models/partition.rb', line 93

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'DeviceName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @device_name = v
    when 'PartitionGuid'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @partition_guid = v
    when 'PartitionOffset'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @partition_offset = v
    when 'Filesystem'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @filesystem = v
    when 'VolumeName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @volume_name = v
    when 'VolumeGuid'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @volume_guid = v
    when 'VolumeSerial'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @volume_serial = v
    when 'MountPoints'
      if v.nil?
        @mount_points = []
      else
        @mount_points = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @mount_points[i1] = v1
        end
      end
    when 'ReadOffset'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @read_offset = v
    when 'Size'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @size = v
    when 'UsedSize'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @used_size = v
    when 'Flags'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @flags = v
    when 'BytesPerFilesystemCluster'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @bytes_per_filesystem_cluster = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


86
87
88
89
90
 
# File 'lib/comet/models/partition.rb', line 86

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



186
187
188
 
# File 'lib/comet/models/partition.rb', line 186

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/comet/models/partition.rb', line 164

def to_hash
  ret = {}
  ret['DeviceName'] = @device_name
  ret['PartitionGuid'] = @partition_guid
  ret['PartitionOffset'] = @partition_offset
  ret['Filesystem'] = @filesystem
  ret['VolumeName'] = @volume_name
  ret['VolumeGuid'] = @volume_guid
  ret['VolumeSerial'] = @volume_serial
  ret['MountPoints'] = @mount_points
  ret['ReadOffset'] = @read_offset
  ret['Size'] = @size
  ret['UsedSize'] = @used_size
  ret['Flags'] = @flags
  ret['BytesPerFilesystemCluster'] = @bytes_per_filesystem_cluster
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



191
192
193
 
# File 'lib/comet/models/partition.rb', line 191

def to_json(options = {})
  to_hash.to_json(options)
end