Struct Type

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

Describes a kind of value.

To style your document, you need to work with values of different kinds: Lengths specifying the size of your elements, colors for your text and shapes, and more. Typst categorizes these into clearly defined types and tells you where it expects which type of value.

Apart from basic types for numeric values and typical types known from programming languages, Typst provides a special type for content. A value of this type can hold anything that you can enter into your document: Text, elements like headings and shapes, and style information.

Example

#let x = 10
#if type(x) == int [
  #x is an integer!
] else [
  #x is another value...
]

An image is of type
#type(image("glacier.jpg")).

The type of 10 is int. Now, what is the type of int or even type?

#type(int) \
#type(type)

Compatibility

In Typst 0.7 and lower, the type function returned a string instead of a type. Compatibility with the old way will remain until Typst 0.14 to give package authors time to upgrade.

• Checks like {int == "integer"} evaluate to {true}
• Adding/joining a type and string will yield a string
• The {in} operator on a type and a dictionary will evaluate to {true} if the dictionary has a string key matching the type’s name

Implementations

impl Type

pub fn of<T: NativeType>() -> Self

Get the type for T.

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

The type’s short name, how it is used in code (e.g. str).

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

The type’s long name, for use in diagnostics (e.g. string).

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

The type’s title case name, for use in documentation (e.g. String).

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

Documentation for the type (as Markdown).

pub fn keywords(&self) -> &'static [&'static str]

Search keywords for the type.

pub fn constructor(&self) -> StrResult<Func>

This type’s constructor function.

pub fn scope(&self) -> &'static Scope

The type’s associated scope that holds sub-definitions.

pub fn field( &self, field: &str, sink: impl DeprecationSink, ) -> StrResult<&'static Value>

Get a field from this type’s scope, if possible.

impl Type

pub fn compat_name(&self) -> &str

The type’s backward-compatible name.

impl Type

pub fn construct(value: Value) -> Type

Determines a value’s type.

#type(12) \
#type(14.7) \
#type("hello") \
#type(<glacier>) \
#type([Hi]) \
#type(x => x + 1) \
#type(type)

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl Display for Type

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

Formats the value using the given formatter.

impl From<&'static NativeTypeData> for Type

fn from(data: &'static NativeTypeData) -> Self

Converts to this type from the input type.

impl FromValue for Type

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

Try to cast the value into an instance of Self.

impl Hash for Type

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 Type

fn into_value(self) -> Value

Cast this type into a value.

impl NativeScope for Type

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 Type

const NAME: &'static str = "type"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl Ord for Type

fn cmp(&self, other: &Self) -> 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,

Restrict a value to a certain interval.

impl PartialEq for Type

fn eq(&self, other: &Type) -> 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 PartialOrd for Type

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Reflect for Type

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 Type

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Copy for Type

impl Eq for Type

impl StructuralPartialEq for Type