Skip to main content

ComponentPreview

dmc_transform::builtin

Struct ComponentPreview 

Source 
pub struct ComponentPreview {
    pub registry_index: Option<PathBuf>,
    pub registry_root: Option<PathBuf>,
}
Expand description

Replace <ComponentPreview name="X" /> with a CodeBlock carrying the source of registry component X. registry_index is the JSON manifest; registry_root is the directory referenced paths resolve against.

Fields§

§registry_index: Option<PathBuf>§registry_root: Option<PathBuf>

Implementations§

Source§

impl ComponentPreview

Source

pub fn new(registry_index: PathBuf, registry_root: PathBuf) -> Self

Both paths required. Default leaves them None so the pass no-ops.

Trait Implementations§

Source§

impl Default for ComponentPreview

Source§

fn default() -> ComponentPreview

Returns the “default value” for a type. Read more
Source§

impl Transformer for ComponentPreview

Source§

fn name(&self) -> &str

Stable identifier for logging / error reporting.
Source§

fn transform( &self, doc: &mut Document, _meta: &SourceMeta, diag_engine: &mut DiagnosticEngine<Code>, )

Mutate doc in place. May be a no-op when preconditions (config, environment, feature flags) aren’t met.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.