Struct Symbol

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

A Unicode symbol.

Typst defines common symbols so that they can easily be written with standard keyboards. The symbols are defined in modules, from which they can be accessed using field access notation:

• General symbols are defined in the sym module
• Emoji are defined in the emoji module

Moreover, you can define custom symbols with this type’s constructor function.

#sym.arrow.r \
#sym.gt.eq.not \
$gt.eq.not$ \
#emoji.face.halo

Many symbols have different variants, which can be selected by appending the modifiers with dot notation. The order of the modifiers is not relevant. Visit the documentation pages of the symbol modules and click on a symbol to see its available variants.

$arrow.l$ \
$arrow.r$ \
$arrow.t.quad$

Implementations

impl Symbol

pub const fn single(c: char) -> Symbol

Create a new symbol from a single character.

pub const fn list(list: &'static [(&'static str, char)]) -> Symbol

Create a symbol with a static variant list.

pub fn runtime(list: Box<[(EcoString, char)]>) -> Symbol

Create a symbol with a runtime variant list.

pub fn get(&self) -> char

Get the symbol’s character.

pub fn func(&self) -> Result<Func, EcoString>

Try to get the function associated with the symbol, if any.

pub fn modified(self, modifier: &str) -> Result<Symbol, EcoString>

Apply a modifier to the symbol.

pub fn variants(&self) -> impl Iterator<Item = (&str, char)>

The characters that are covered by this symbol.

pub fn modifiers(&self) -> impl Iterator<Item = &str>

Possible modifiers.

impl Symbol

pub fn construct( span: Span, variants: Vec<Spanned<SymbolVariant>>, ) -> Result<Symbol, EcoVec<SourceDiagnostic>>

Create a custom symbol with modifiers.

#let envelope = symbol(
  "🖂",
  ("stamped", "🖃"),
  ("stamped.pen", "🖆"),
  ("lightning", "🖄"),
  ("fly", "🖅"),
)

#envelope
#envelope.stamped
#envelope.stamped.pen
#envelope.lightning
#envelope.fly

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Display for Symbol

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

Formats the value using the given formatter.

impl From<Symbol> for Symbol

fn from(symbol: Symbol) -> Symbol

Converts to this type from the input type.

impl FromValue for Symbol

fn from_value(value: Value) -> Result<Symbol, HintedString>

Try to cast the value into an instance of Self.

impl Hash for Symbol

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

where __H: Hasher,

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 Symbol

fn into_value(self) -> Value

Cast this type into a value.

impl NativeScope for Symbol

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 Symbol

const NAME: &'static str = "symbol"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl PartialEq for Symbol

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Reflect for Symbol

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) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for Symbol

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Serialize for Symbol

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Symbol

impl StructuralPartialEq for Symbol