Skip to main content

SetArg

Enum SetArg 

Source
pub enum SetArg {
    Named {
        key: String,
        value: SetValue,
        key_span: SourceSpan,
        value_span: SourceSpan,
    },
    Positional {
        value: SetValue,
        value_span: SourceSpan,
    },
}
Expand description

One argument inside a directive body: either a key: value pair (the only form #set accepts) or a positional value (a leading string literal allowed on #image(...) / #figure(...)).

This used to be a struct with an empty-string key standing in for “positional,” but that sentinel was a brittle public contract: any consumer that forgot the special-case would silently treat a positional path as a named arg called "". The enum form makes the two shapes explicit so the compiler can enforce exhaustive matches.

Variants§

§

Named

A key: value argument. key_span covers the identifier before the colon; value_span covers the literal.

Fields

§value: SetValue
§key_span: SourceSpan
§value_span: SourceSpan
§

Positional

A leading positional value. The parser currently only accepts string literals here (used for #image("path.png")); other literal kinds in a positional slot would surface as a parse error rather than land in this variant.

Fields

§value: SetValue
§value_span: SourceSpan

Implementations§

Source§

impl SetArg

Source

pub fn value(&self) -> &SetValue

Borrow the value carried by this argument, regardless of shape.

Source

pub fn value_span(&self) -> &SourceSpan

The span covering the argument’s value literal.

Source

pub fn key(&self) -> Option<&str>

The key identifier for Self::Named; None for Self::Positional.

Source

pub fn key_span(&self) -> Option<&SourceSpan>

The span covering the key identifier, for Self::Named. None for Self::Positional.

Trait Implementations§

Source§

impl Clone for SetArg

Source§

fn clone(&self) -> SetArg

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SetArg

Source§

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

Formats the value using the given formatter. 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.

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