Skip to main content

VariableContext

Struct VariableContext 

Source
pub struct VariableContext {
Show 16 fields pub selected_text: Option<String>, pub current_line: Option<String>, pub current_word: Option<String>, pub line_index: Option<u32>, pub filename: Option<String>, pub directory: Option<String>, pub filepath: Option<String>, pub workspace_name: Option<String>, pub workspace_folder: Option<String>, pub clipboard: Option<String>, pub line_comment: Option<String>, pub block_comment_start: Option<String>, pub block_comment_end: Option<String>, pub extra: HashMap<String, String>, pub fixed_now: Option<TimestampParts>, pub fixed_random: Option<u64>,
}
Expand description

Editor-supplied context the renderer consults to resolve variable references. The host fills in the file / cursor fields; timestamp + random / UUID values are computed at expansion time inside VariableContext::resolve.

extra is the plugin / user-defined variable slot – values the host wants to expose without subclassing. Names lookup falls through to extra when the built-in set doesn’t recognise the name.

Fields§

§selected_text: Option<String>§current_line: Option<String>§current_word: Option<String>§line_index: Option<u32>

0-based.

§filename: Option<String>§directory: Option<String>§filepath: Option<String>§workspace_name: Option<String>§workspace_folder: Option<String>§clipboard: Option<String>§line_comment: Option<String>§block_comment_start: Option<String>§block_comment_end: Option<String>§extra: HashMap<String, String>

User / plugin extras. Looked up after the built-in set.

§fixed_now: Option<TimestampParts>

Optional fixed timestamp (for tests). When None, the renderer reads SystemTime::now().

§fixed_random: Option<u64>

Optional fixed random seed (for tests).

Implementations§

Source§

impl VariableContext

Source

pub fn resolve(&self, name: &str) -> Option<String>

Resolve a variable name to its expansion text. Returns None when neither the built-in set nor extra knows the name – the renderer then emits the snippet’s fallback (default body) or empty string.

Trait Implementations§

Source§

impl Clone for VariableContext

Source§

fn clone(&self) -> VariableContext

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 VariableContext

Source§

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

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

impl Default for VariableContext

Source§

fn default() -> VariableContext

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

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> 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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more