Skip to main content

RenderContext

Struct RenderContext 

Source
pub struct RenderContext<'a> {
    pub branch_name: &'a str,
    pub branch_slug: &'a str,
    pub workspace: &'a str,
    pub scripts: &'a str,
    pub ports: Option<&'a BTreeMap<String, u16>>,
    pub exports: Option<&'a BTreeMap<String, String>>,
    pub snapshot_path: Option<&'a str>,
    pub state_ref: Option<&'a str>,
}
Expand description

The minimal template variable set for exports and action commands: {{ports.<name>}}, {{branch.name}}, {{branch.slug}}, {{workspace}}, {{scripts}}.

Checkpoint and restore commands additionally see {{exports.<name>}}, {{snapshot.path}} (the staging dir for into_tracker deposits), and {{state_ref}} (the checkpointed state reference). Those stay None everywhere else — action and export rendering is deliberately minimal.

Fields§

§branch_name: &'a str§branch_slug: &'a str§workspace: &'a str§scripts: &'a str

The store’s .newgit/scripts/, so a command can shell out to a script that lives beside the definition calling it instead of in the workspace, where it would be subject to source materialization.

§ports: Option<&'a BTreeMap<String, u16>>§exports: Option<&'a BTreeMap<String, String>>§snapshot_path: Option<&'a str>§state_ref: Option<&'a str>

Trait Implementations§

Source§

impl<'a> Clone for RenderContext<'a>

Source§

fn clone(&self) -> RenderContext<'a>

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<'a> Debug for RenderContext<'a>

Source§

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

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

impl<'a> Default for RenderContext<'a>

Source§

fn default() -> RenderContext<'a>

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

Auto Trait Implementations§

§

impl<'a> Freeze for RenderContext<'a>

§

impl<'a> RefUnwindSafe for RenderContext<'a>

§

impl<'a> Send for RenderContext<'a>

§

impl<'a> Sync for RenderContext<'a>

§

impl<'a> Unpin for RenderContext<'a>

§

impl<'a> UnsafeUnpin for RenderContext<'a>

§

impl<'a> UnwindSafe for RenderContext<'a>

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> 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> 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> Same for T

Source§

type Output = T

Should always be Self
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.