Struct libzetta::zpool::properties::ZpoolProperties

pub struct ZpoolProperties { /* private fields */ }

All pre-defined properties of Zpool - both immutable and mutable. Majority of this documentation lifted from manual page.

Implementations

impl ZpoolProperties

pub fn alloc(&self) -> &usize

Amount of storage space within the pool that has been physically allocated.

pub fn capacity(&self) -> &u8

Percentage of pool space used. Percentage.

pub fn comment(&self) -> &Option<String>

A text string consisting of printable ASCII characters that will be stored such that it is available even if the pool becomes faulted. An administrator can provide additional information about a pool using this property.

pub fn dedup_ratio(&self) -> &f64

The deduplication ratio specified for a pool, expressed as a multiplier. For example, a dedupratio value of 1.76 indicates that 1.76 units of data were stored but only 1 unit of disk space was actually consumed. See zfs(8) for a description of the deduplication feature.

pub fn expand_size(&self) -> &Option<usize>

Amount of uninitialized space within the pool or device that can be used to increase the total capacity of the pool. Uninitialized space consists of any space on an EFI labeled vdev, which has not been brought online (i.e. zpool online -e). This space occurs when a LUN is dynamically expanded.

pub fn fragmentation(&self) -> &i8

The amount of fragmentation in the pool. In percents.

pub fn free(&self) -> &i64

Number of blocks within the pool that are not allocated.

pub fn freeing(&self) -> &i64

After a file system or snapshot is destroyed, the space it was using is returned to the pool asynchronously. freeing is the amount of space remaining to be reclaimed. Over time freeing will decrease while free increases.

pub fn guid(&self) -> &u64

A unique identifier for the pool.

pub fn health(&self) -> &Health

The current health of the pool.

pub fn size(&self) -> &usize

Total size of the storage pool.

pub fn leaked(&self) -> &usize

Leaked space?

pub fn alt_root(&self) -> &Option<PathBuf>

Alternate root directory, can only be set during creation or import.

pub fn read_only(&self) -> &bool

Pool is read only

pub fn auto_expand(&self) -> &bool

Controls automatic pool expansion when the underlying LUN is grown.

pub fn auto_replace(&self) -> &bool

Controls automatic device replacement. If set to “on”, any new device, found in the same physical location as a device that previously belonged to the pool, is automatically formatted and replaced. The default behavior is “off”.

pub fn boot_fs(&self) -> &Option<String>

Identifies the default bootable dataset for the root pool.

pub fn cache_file(&self) -> &CacheType

Controls the location of where the pool configuration is cached.

pub fn dedup_ditto(&self) -> &usize

Threshold for the number of block ditto copies. If the reference count for a deduplicated block increases above this number, a new ditto copy of this block is automatically stored. Default setting is 0 which causes no ditto copies to be created for deduplicated blocks. The minimum legal nonzero setting is 100.

pub fn delegation(&self) -> &bool

Controls whether a non-privileged user is granted access based on the dataset permissions defined on the dataset. See zfs(8) for more information on ZFS delegated administration.

pub fn fail_mode(&self) -> &FailMode

Controls the system behavior in the event of catastrophic pool failure. This condition is typically a result of a loss of connectivity to the underlying storage device(s) or a failure of all devices within the pool.

Trait Implementations

impl Clone for ZpoolProperties

fn clone(&self) -> ZpoolProperties

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ZpoolProperties

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<ZpoolProperties> for ZpoolProperties

fn eq(&self, other: &ZpoolProperties) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ZpoolProperties