Struct freebsd_geom::Geom

pub struct Geom {
    pub class: GeomClass,
    pub name: String,
    pub rank: u64,
    pub metadata: Option<Box<PartMetadata>>,
}

A Geom is the essential object in a GEOM graph.

It has a name and “rank” (a computed depth of the tree containing this geom). It can represent a disk (GeomClass::DISK), or partition (GeomClass::PART), or /dev device node (GeomClass::DEV), as well as several other classes.

A geom may have some associated metadata (e.g., PART geoms).

A geom is related to other geoms in a tree. In this library, we call edges from child to parent geoms “outedges” and edges from parent geoms to child geoms “inedges”. In other GEOM documentation they are called “consumers” and “providers,” respectively.

Fields

class: GeomClass

name: String

The Geom’s name, such as “ada0”. Caveat: geom names are not unique.

rank: u64

The height of this Geom in its tree. For example, a Geom at the root of a tree will have rank equal to 1.

metadata: Option<Box<PartMetadata>>

If this Geom is GeomClass::PART, some additional metadata.

Trait Implementations

impl Debug for Geom

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

Formats the value using the given formatter.