Skip to main content

RunContext

Struct RunContext 

Source
#[non_exhaustive]
pub struct RunContext<'a> { pub theme: &'a Theme, pub capability: Capability, pub terminal_width: u16, pub cwd: Option<PathBuf>, pub hyperlinks: bool, }
Expand description

CLI run-state bundle: theme + capability + terminal width + cwd. Passed to run_with_context; the CLI driver builds one from config (theme name), the color-policy precedence chain (CLI flags / env / config), CliEnv.terminal_width minus any padding, and the process cwd. Distinct from segments::RenderContext, which is the per-segment-render layout state.

cwd seeds gix repo discovery. None skips discovery entirely; Some(path) runs gix::discover(path) on the first ctx.git() read.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§theme: &'a Theme§capability: Capability§terminal_width: u16§cwd: Option<PathBuf>§hyperlinks: bool

Whether the terminal advertises OSC 8 hyperlink support. Drives emission of Style.hyperlink URLs in layout::runs_to_ansi; orthogonal to color capability since hyperlinks and color support are independent terminal features.

Implementations§

Source§

impl<'a> RunContext<'a>

Source

pub fn new( theme: &'a Theme, capability: Capability, terminal_width: u16, cwd: Option<PathBuf>, hyperlinks: bool, ) -> Self

Build a RunContext. The struct is #[non_exhaustive] so struct-literal construction is blocked downstream; benches, out-of-tree embedders, and in-crate call sites all go through this constructor so future field additions touch one site.

terminal_width is forwarded as-is. The layout engine treats 0 as “no budget” and drops every droppable segment; callers that want a default should use detect_terminal_width or DEFAULT_TERMINAL_WIDTH instead of relying on the sentinel.

Trait Implementations§

Source§

impl<'a> Clone for RunContext<'a>

Source§

fn clone(&self) -> RunContext<'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 RunContext<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for RunContext<'a>

§

impl<'a> RefUnwindSafe for RunContext<'a>

§

impl<'a> Send for RunContext<'a>

§

impl<'a> Sync for RunContext<'a>

§

impl<'a> Unpin for RunContext<'a>

§

impl<'a> UnsafeUnpin for RunContext<'a>

§

impl<'a> UnwindSafe for RunContext<'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> 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> 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 = 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.