Struct ExportSpec 

pub struct ExportSpec {
    pub name: String,
    pub label: Option<String>,
    pub gate: Gate,
    pub view: Option<String>,
}

One export a workspace declares for itself: a gate that bounds what leaves, optionally arranged by a view.

Fields

name: String

The key under exports — the export’s public handle (a path segment, an OCFL object prefix). Deliberately its own name rather than the gate value’s: the honest name for a readership is routinely one its members should never read off a URL, and separating them lets two gates share an arrangement or one gate carry two exports.

label: Option<String>

What a person calls it. Absent falls back to the name, humanized.

gate: Gate

The gate whose admitted set bounds this export. Required: an export that does not say what may leave is not an export.

view: Option<String>

The ViewSpec naming this export’s arrangement, by its key under views:. None exports the gate’s whole admitted set. A view may narrow the set; it can never widen it — see plan.

Implementations

impl ExportSpec

pub fn parse(name: &str, value: &Value) -> Option<ExportSpec>

Read one exports.<name> entry.

Returns None when the entry is not a mapping or carries no readable Gate. Dropping such an entry is the fail-closed direction — an unreadable export declaration exports nothing, where defaulting its gate would export a set nobody chose. crate::diagnose_export is the half that says why, so a malformed entry is reported rather than merely dropped.

pub fn to_mapping(&self) -> IndexMap<String, Value>

The mapping this export writes back as. Absent options are omitted rather than written empty, so an export declared from an app reads as the small thing it is.

pub fn display_label(&self) -> String

What a person calls this export: its label, else its name humanized.

Trait Implementations

impl Clone for ExportSpec

fn clone(&self) -> ExportSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExportSpec

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

Formats the value using the given formatter.

impl Eq for ExportSpec

impl PartialEq for ExportSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ExportSpec