Solid::StorageVolume Class
class Solid::StorageVolume| Header: | #include <StorageVolume> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS Solid)target_link_libraries(mytarget PRIVATE KF6::Solid) |
| Inherits: | Solid::DeviceInterface |
| Inherited By: |
Public Types
| enum | UsageType { Other, Unused, FileSystem, PartitionTable, Raid, Encrypted } |
Public Functions
| virtual | ~StorageVolume() override |
| 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() |
Protected Functions
| StorageVolume(Solid::StorageVolumePrivate &dd, QObject *backendObject) |
Detailed Description
@class Solid::StorageVolume storagevolume.h <Solid/StorageVolume>
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.
Member Type Documentation
enum StorageVolume::UsageType
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
Member Function Documentation
[protected] StorageVolume::StorageVolume(Solid::StorageVolumePrivate &dd, QObject *backendObject)
@internal
[override virtual noexcept] StorageVolume::~StorageVolume()
Destroys a StorageVolume object.
[static] Solid::DeviceInterface::Type StorageVolume::deviceInterfaceType()
Get the Solid::DeviceInterface::Type of the StorageVolume device interface.
@return the StorageVolume device interface type @see Solid::DeviceInterface::Type
Solid::Device StorageVolume::encryptedContainer() const
Retrieves the crypto container of this volume.
@return 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?
@return 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.
@return true if the volume should be ignored
Note: Getter function for property ignored.
QString StorageVolume::label() const
Retrieves this volume label.
@return the volume label if available, QString() otherwise
Note: Getter function for property label.
qulonglong StorageVolume::size() const
Retrieves this volume size in bytes.
@return 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).
@return the usage type @see Solid::StorageVolume::UsageType
Note: Getter function for property usage.
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.
@return the Universal Unique IDentifier if available, QString() otherwise
Note: Getter function for property uuid.