Struct ElementDoc 

pub struct ElementDoc {
    pub name: String,
    pub long_name: String,
    pub klass: String,
    pub description: String,
    pub author: String,
    pub role: String,
    pub experimental: bool,
    pub caps: Option<String>,
    pub pads: Vec<String>,
    pub properties: Vec<PropertyDoc>,
}

Structured, owned introspection of one registered element: the same facts Registry::inspect renders as a gst-inspect text dump, exposed as data so external tooling (the searchable element reference on the docs site, generated by g2g-docgen) reads from one source of truth. Built by Registry::describe / Registry::describe_all.

Fields

name: String

Registry / gst-launch name.

long_name: String

Human-readable long name (may be empty).

klass: String

Classification (klass), e.g. "Codec/Encoder/Audio".

description: String

One-paragraph description of what the element does.

author: String

Author / origin.

role: String

"source", "element", or "muxer (fan-in)".

experimental: bool

Host- or device-only runtime path: compiled, not promised in CI. See STABILITY.md (Tier 3).

caps: Option<String>

Output caps (sources / muxers), the debug spelling; None for a transform / sink, which advertises pad templates instead.

pads: Vec<String>

Pad templates as "DIR: caps" lines (transforms / sinks).

properties: Vec<PropertyDoc>

Settable properties, in declaration order.

Trait Implementations

impl Clone for ElementDoc

fn clone(&self) -> ElementDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElementDoc

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

Formats the value using the given formatter.