Skip to main content

SourceConfig

Struct SourceConfig 

Source
pub struct SourceConfig { /* private fields */ }
Expand description

One named source, as a document configures it.

Built by Config::from_document, never deserialized directly: plugin is a PluginKind rather than the string the document spelled, so a source naming a plugin this build does not have cannot be represented here at all.

Implementations§

Source§

impl SourceConfig

Source

pub fn plugin(&self) -> PluginKind

The plugin kind that builds this source.

Source

pub fn config(&self) -> &Value

The plugin’s own block.

Opaque here on purpose — a plugin’s fields are the plugin’s, and typing them in the engine would put every plugin’s shape in the engine. What holds instead is that Config::from_document checks each block against the schema its own plugin declares, and this field is not public, so no SourceConfig anybody can reach carries a block that plugin would refuse.

Source

pub fn document_dir(&self) -> Option<&Path>

The absolute directory holding the configuration document that supplied the block this source hands a child process, or None when no one document did.

Only a subprocess source ever carries one: its settings: block is opaque here, so nothing inside it is rebased in this process, and this is what the child is told instead — document_dir in docs/plugin-protocol.md §3 — so the hosted plugin can resolve its own declared paths exactly as the in-process rule does. It is an engine-owned fact about where the block came from, which is why it is read from the merge’s origins rather than being a setting anybody can write.

Trait Implementations§

Source§

impl Clone for SourceConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SourceConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SourceConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SourceConfig

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.