Solid::StorageVolume Class
class Solid::StorageVolumeThis device interface is available on volume devices. More...
| Header: | #include <Solid/StorageVolume> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS Solid)target_link_libraries(mytarget PRIVATE KF6::Solid) |
| Inherits: | Solid::DeviceInterface |
| Inherited By: |
Public Types
| enum | UsageType { FileSystem, PartitionTable, Raid, Other, Unused, Encrypted } |
Properties
Public Functions
| Solid::Device | encryptedContainer() const |
| QString | fsType() const |
| bool | isIgnored() const |
| QString | label() const |
| qulonglong | size() const |
| Solid::StorageVolume::UsageType | usage() const |
| QString | uuid() const |
Static Public Members
| Solid::DeviceInterface::Type | deviceInterfaceType() |
Detailed Description
A volume is anything that can contain data (partition, optical disc, memory card). It's a particular kind of block device.
Member Type Documentation
enum StorageVolume::UsageType
This enum type defines the how a volume is used.
| Constant | Value | Description |
|---|---|---|
Solid::StorageVolume::FileSystem | 2 | A mountable filesystem volume |
Solid::StorageVolume::PartitionTable | 3 | A volume containing a partition table |
Solid::StorageVolume::Raid | 4 | A volume member of a raid set (not mountable) |
Solid::StorageVolume::Other | 0 | A not mountable volume (like a swap partition) |
Solid::StorageVolume::Unused | 1 | An unused or free volume |
Solid::StorageVolume::Encrypted | 5 |
Property Documentation
[read-only] fsType : const QString
Access functions:
| QString | fsType() const |
[read-only] ignored : const bool
Access functions:
| bool | isIgnored() const |
[read-only] label : const QString
Access functions:
| QString | label() const |
[read-only] size : const qulonglong
Access functions:
| qulonglong | size() const |
[read-only] usage : const UsageType
Access functions:
| Solid::StorageVolume::UsageType | usage() const |
[read-only] uuid : const QString
Access functions:
| QString | uuid() const |
Member Function Documentation
[static] Solid::DeviceInterface::Type StorageVolume::deviceInterfaceType()
Get the Solid::DeviceInterface::Type of the StorageVolume device interface.
Returns the StorageVolume device interface type
See also Solid::DeviceInterface::Type.
Solid::Device StorageVolume::encryptedContainer() const
Retrieves the crypto container of this volume.
Returns the encrypted volume containing the current volume if applicable, an invalid device otherwise
QString StorageVolume::fsType() const
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
Note: Getter function for property fsType.
bool StorageVolume::isIgnored() const
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
Note: Getter function for property ignored.
QString StorageVolume::label() const
Retrieves this volume label.
Returns the volume label if available, QString() otherwise
Note: Getter function for property label.
qulonglong StorageVolume::size() const
Retrieves this volume size in bytes.
Returns the size of this volume
Note: Getter function for property size.
Solid::StorageVolume::UsageType StorageVolume::usage() const
Retrieves the type of use for this volume (for example filesystem).
Returns the usage type
Note: Getter function for property usage.
See also Solid::StorageVolume::UsageType.
QString StorageVolume::uuid() const
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
Note: Getter function for property uuid.