# class StorageVolume

###

Module | solid
Namespace | Solid
Class | StorageVolume
Inherits | Solid::DeviceInterface

This device interface is available on volume devices.

A volume is anything that can contain data (partition, optical disc, memory card). It's a particular kind of block device.

### enums

- UsageType { Other, Unused, FileSystem, PartitionTable, Raid, Encrypted }

enum details

### methods

- StorageVolume (backendObject)

  returns ctor
  Not implemented
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  backendObject | QObject |

  Creates a new StorageVolume object. You generally won't need this. It's created when necessary using Device.as().

  backendObject - the device interface object provided by the backend

  See also Solid.Device.as()

- StorageVolume (dd, backendObject)

  returns ctor
  Not implemented

  Argument | Type | Default
  --- | --- | ---
  dd | StorageVolumePrivate |
  backendObject | QObject |

  Internal

- StorageVolume (a0)

  returns ctor
  Not implemented
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | QObject |

- deviceInterfaceType ( )

  returns Solid::DeviceInterface.Type
  static

  Get the Solid.DeviceInterface.Type of the StorageVolume device interface.

  Returns the StorageVolume device interface type

  See also Solid.Ifaces.Enums.DeviceInterface.Type

- encryptedContainer ( )

  returns Solid.Device

  Retrieves the crypto container of this volume.

  Returns the encrypted volume containing the current volume if appliable, an invalid device otherwise

- fsType ( )

  returns QString

  Retrieves the filesystem type of this volume.

  FIXME: It's a platform dependent string, maybe we should switch to an enum?

  Returns the filesystem type if applicable, QString() otherwise

- isIgnored ( )

  returns bool

  Indicates if this volume should be ignored by applications.

  If it should be ignored, it generally means that it should be invisible to the user. It's useful for firmware partitions or OS reinstall partitions on some systems.

  Returns true if the volume should be ignored

- label ( )

  returns QString

  Retrieves this volume label.

  Returns the volume label if available, QString() otherwise

- size ( )

  returns qulonglong

  Retrieves this volume size in bytes.

  Returns the size of this volume

- usage ( )

  returns Solid::StorageVolume.UsageType

  Retrieves the type of use for this volume (for example filesystem).

  Returns the usage type

  See also Solid.Ifaces.Enums.StorageVolume.UsageType

- uuid ( )

  returns QString

  Retrieves this volume Universal Unique IDentifier (UUID).

  You can generally assume that this identifier is unique with reasonable confidence. Except if the volume UUID has been forged to intentionally provoke a collision, the probability to have two volumes having the same UUID is low.

  Returns the Universal Unique IDentifier if available, QString() otherwise

### enums - detail

- UsageType { Other, Unused, FileSystem, PartitionTable, Raid, Encrypted }

  This enum type defines the how a volume is used.

  - FileSystem : A mountable filesystem volume - PartitionTable : A volume containing a partition table - Raid : A volume member of a raid set (not mountable) - Other : A not mountable volume (like a swap partition) - Unused : An unused or free volume

  | Other | - 0 | - |
  | Unused | - 1 | - |
  | FileSystem | - 2 | - |
  | PartitionTable | - 3 | - |
  | Raid | - 4 | - |
  | Encrypted | - 5 | - |