Struct typst::foundations::Label

pub struct Label(/* private fields */);

A label for an element.

Inserting a label into content attaches it to the closest preceding element that is not a space. The preceding element must be in the same scope as the label, which means that [Hello #[<label>]], for instance, wouldn’t work.

A labelled element can be referenced, queried for, and styled through its label.

Once constructed, you can get the name of a label using str.

Example

#show <a>: set text(blue)
#show label("b"): set text(red)

= Heading <a>
*Strong* #label("b")

Syntax

This function also has dedicated syntax: You can create a label by enclosing its name in angle brackets. This works both in markup and code. A label’s name can contain letters, numbers, _, -, :, and ..

Currently, labels can only be attached to elements in markup mode, not in code mode. This might change in the future.

Implementations

impl Label

pub fn new(name: impl Into<PicoStr>) -> Self

Creates a label from a string, interning it.

pub fn as_str(&self) -> &'static str

Resolves the label to a string.

pub fn into_inner(self) -> PicoStr

Turns this label into its inner interned string.

impl Label

pub fn construct(name: PicoStr) -> Label

Creates a label from a string.

Trait Implementations

impl Clone for Label

fn clone(&self) -> Label

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Label

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

Formats the value using the given formatter.

impl From<Label> for PicoStr

fn from(value: Label) -> Self

Converts to this type from the input type.

impl FromValue for Label

fn from_value(value: Value) -> StrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for Label

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoValue for Label

fn into_value(self) -> Value

Cast this type into a value.

impl NativeScope for Label

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl NativeType for Label

const NAME: &'static str = "label"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl Ord for Label

fn cmp(&self, other: &Label) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Label

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Label

fn partial_cmp(&self, other: &Label) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Reflect for Label

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> EcoString

Produce an error message for an inacceptable value type.

impl Repr for Label

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Copy for Label

impl Eq for Label

impl StructuralPartialEq for Label