libstorage-ng
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
storage::Partition Class Reference

A partition of a Partitionable, e.g. Disk or Md. More...

#include <Partition.h>

Inheritance diagram for storage::Partition:
[legend]
Collaboration diagram for storage::Partition:
[legend]

Public Member Functions

unsigned int get_number () const
 
PartitionType get_type () const
 
void set_type (PartitionType type)
 
unsigned int get_id () const
 
void set_id (unsigned int id)
 
bool is_boot () const
 Query the boot flag of the partition.
 
void set_boot (bool boot)
 Set the boot flag of the partition. More...
 
bool is_legacy_boot () const
 Query the legacy boot flag of the partition.
 
void set_legacy_boot (bool legacy_boot)
 Set the legacy boot flag of the partition. More...
 
const PartitionTableget_partition_table () const
 
const Partitionableget_partitionable () const
 
Region get_unused_surrounding_region () const
 Returns the unused region surrounding the partition (including the partition itself). More...
 
Impl & get_impl ()
 
const Impl & get_impl () const
 
virtual Partitionclone () const override
 
- Public Member Functions inherited from storage::BlkDevice
const std::string & get_name () const
 
void set_name (const std::string &name)
 
const Regionget_region () const
 
void set_region (const Region &region)
 
unsigned long long get_size () const
 
void set_size (unsigned long long size)
 
std::string get_size_string () const
 
bool is_active () const
 
const std::string & get_sysfs_name () const
 
const std::string & get_sysfs_path () const
 
const std::vector< std::string > & get_udev_paths () const
 
const std::vector< std::string > & get_udev_ids () const
 
bool is_usable_as_blk_device () const
 Checks whether the blk device is in general usable as a blk device. More...
 
const std::string & get_dm_table_name () const
 Return device-mapper table name (dm-table-name for short). More...
 
void set_dm_table_name (const std::string &dm_table_name)
 
BlkFilesystemcreate_blk_filesystem (FsType fs_type)
 Creates a block filesystem on the block device. More...
 
bool has_blk_filesystem () const
 
BlkFilesystemget_blk_filesystem ()
 
const BlkFilesystemget_blk_filesystem () const
 
BlkFilesystemcreate_filesystem (FsType fs_type) ST_DEPRECATED
 Creates a block filesystem on the block device. More...
 
bool has_filesystem () const ST_DEPRECATED
 
BlkFilesystemget_filesystem () ST_DEPRECATED
 
const BlkFilesystemget_filesystem () const ST_DEPRECATED
 
Encryptioncreate_encryption (const std::string &dm_name)
 Creates an encryption device on the blk device. More...
 
void remove_encryption ()
 Removes an encryption device on the blk device. More...
 
bool has_encryption () const
 
Encryptionget_encryption ()
 
const Encryptionget_encryption () const
 
Impl & get_impl ()
 
const Impl & get_impl () const
 
- Public Member Functions inherited from storage::Device
sid_t get_sid () const
 
bool operator== (const Device &rhs) const
 
bool operator!= (const Device &rhs) const
 
Devicecopy_to_devicegraph (Devicegraph *devicegraph) const
 Copies the device to the devicegraph. More...
 
bool exists_in_devicegraph (const Devicegraph *devicegraph) const
 Checks if the device exists in the devicegraph.
 
bool exists_in_probed () const
 Checks if the device exists in the probed devicegraph.
 
bool exists_in_staging () const
 Checks if the device exists in the staging devicegraph.
 
bool exists_in_system () const
 Checks if the device exists in the system devicegraph.
 
std::string get_displayname () const
 
ResizeInfo detect_resize_info () const
 Detect the resize info of the device. More...
 
bool has_children () const
 
size_t num_children () const
 
bool has_parents () const
 
size_t num_parents () const
 
std::vector< Device * > get_children ()
 
std::vector< const Device * > get_children () const
 
std::vector< Device * > get_parents ()
 
std::vector< const Device * > get_parents () const
 
std::vector< Device * > get_siblings (bool itself)
 
std::vector< const Device * > get_siblings (bool itself) const
 
std::vector< Device * > get_descendants (bool itself)
 
std::vector< const Device * > get_descendants (bool itself) const
 
std::vector< Device * > get_ancestors (bool itself)
 
std::vector< const Device * > get_ancestors (bool itself) const
 
std::vector< Device * > get_leaves (bool itself)
 
std::vector< const Device * > get_leaves (bool itself) const
 
std::vector< Device * > get_roots (bool itself)
 
std::vector< const Device * > get_roots (bool itself) const
 
std::vector< Holder * > get_in_holders ()
 
std::vector< const Holder * > get_in_holders () const
 
std::vector< Holder * > get_out_holders ()
 
std::vector< const Holder * > get_out_holders () const
 
void remove_descendants ()
 
const std::map< std::string, std::string > & get_userdata () const
 
void set_userdata (const std::map< std::string, std::string > &userdata)
 
Devicegraphget_devicegraph ()
 
const Devicegraphget_devicegraph () const
 
Impl & get_impl ()
 
const Impl & get_impl () const
 
void save (xmlNode *node) const
 

Static Public Member Functions

static Partitioncreate (Devicegraph *devicegraph, const std::string &name, const Region &region, PartitionType type)
 region is sector-based.
 
static Partitionload (Devicegraph *devicegraph, const xmlNode *node)
 
static Partitionfind_by_name (Devicegraph *devicegraph, const std::string &name)
 Find a Partition by its name. More...
 
static const Partitionfind_by_name (const Devicegraph *devicegraph, const std::string &name)
 Find a Partition by its name. More...
 
static bool compare_by_number (const Partition *lhs, const Partition *rhs)
 Compare (less than) two Partitions by number.
 
- Static Public Member Functions inherited from storage::BlkDevice
static std::vector< BlkDevice * > get_all (Devicegraph *devicegraph)
 Get all BlkDevices.
 
static std::vector< const BlkDevice * > get_all (const Devicegraph *devicegraph)
 Get all BlkDevices. More...
 
static BlkDevicefind_by_name (Devicegraph *devicegraph, const std::string &name)
 Find a block device by its name. More...
 
static const BlkDevicefind_by_name (const Devicegraph *devicegraph, const std::string &name)
 Find a block device by its name. More...
 
static BlkDevicefind_by_any_name (Devicegraph *devicegraph, const std::string &name)
 Find a block device by any name including any symbolic links in /dev. More...
 
static const BlkDevicefind_by_any_name (const Devicegraph *devicegraph, const std::string &name)
 Find a block device by any name including any symbolic links in /dev. More...
 
static bool compare_by_dm_table_name (const BlkDevice *lhs, const BlkDevice *rhs)
 Compare (less than) two BlkDevices by DM table name.
 
- Static Public Member Functions inherited from storage::Device
static std::vector< Device * > get_all (Devicegraph *devicegraph)
 
static std::vector< const Device * > get_all (const Devicegraph *devicegraph)
 
static bool compare_by_sid (const Device *lhs, const Device *rhs)
 Compare (less than) two Devices by sid.
 
static bool compare_by_name (const Device *lhs, const Device *rhs)
 Compare (less than) two Devices by name. More...
 

Protected Member Functions

 Partition (Impl *impl)
 
- Protected Member Functions inherited from storage::BlkDevice
 BlkDevice (Impl *impl)
 
- Protected Member Functions inherited from storage::Device
 Device (Impl *impl)
 
void create (Devicegraph *devicegraph)
 
void load (Devicegraph *devicegraph)
 

Detailed Description

A partition of a Partitionable, e.g. Disk or Md.

Member Function Documentation

◆ find_by_name() [1/2]

static Partition* storage::Partition::find_by_name ( Devicegraph devicegraph,
const std::string &  name 
)
static

Find a Partition by its name.

Only the name returned by get_name() is considered.

Exceptions
DeviceNotFound,DeviceHasWrongType

◆ find_by_name() [2/2]

static const Partition* storage::Partition::find_by_name ( const Devicegraph devicegraph,
const std::string &  name 
)
static

Find a Partition by its name.

Only the name returned by get_name() is considered.

Exceptions
DeviceNotFound,DeviceHasWrongType

◆ get_unused_surrounding_region()

Region storage::Partition::get_unused_surrounding_region ( ) const

Returns the unused region surrounding the partition (including the partition itself).

The returned region is not aligned.

Exceptions
Exception

◆ set_boot()

void storage::Partition::set_boot ( bool  boot)

Set the boot flag of the partition.

Only supported on Msdos.

Notes:

  1. To be standard-conformant, setting the boot flag on a partition clears the boot flag on all other partitions of the partition table.
  2. Partitions on GPT have no boot flag, "set <nr> boot on" with parted on GPT partitions only sets the partition type to EFI System Partition.
Exceptions
Exception

◆ set_id()

void storage::Partition::set_id ( unsigned int  id)
Exceptions
Exception

◆ set_legacy_boot()

void storage::Partition::set_legacy_boot ( bool  legacy_boot)

Set the legacy boot flag of the partition.

Only supported on Gpt.

Exceptions
Exception

◆ set_type()

void storage::Partition::set_type ( PartitionType  type)
Exceptions
Exception

The documentation for this class was generated from the following file: