Enum Ty

pub enum Ty {
    Any,
    Boolean(Option<bool>),
    Builtin(BuiltinTy),
    Value(Interned<InsTy>),
    Param(Interned<ParamTy>),
    Union(Interned<Vec<Ty>>),
    Let(Interned<TypeBounds>),
    Var(Interned<TypeVar>),
    Dict(Interned<RecordTy>),
    Array(Interned<Ty>),
    Tuple(Interned<Vec<Ty>>),
    Func(Interned<SigTy>),
    Args(Interned<ArgsTy>),
    Pattern(Interned<PatternTy>),
    With(Interned<SigWithTy>),
    Select(Interned<SelectTy>),
    Unary(Interned<TypeUnary>),
    Binary(Interned<TypeBinary>),
    If(Interned<IfTy>),
}

All possible types in tinymist.

Variants

Any

A top type, whose negation is bottom type. t := top, t^- := bottom

Boolean(Option<bool>)

A boolean type, can be false, true, or both (boolean type). t := false | true

Builtin(BuiltinTy)

All possible types in typst.

Value(Interned<InsTy>)

A possible typst instance of some type.

Param(Interned<ParamTy>)

A parameter type

Union(Interned<Vec<Ty>>)

A union type, whose negation is intersection type. t := t1 | t2 | ... | tn, t^- := t1 & t2 & ... & tn

Let(Interned<TypeBounds>)

A frozen type variable. t :> t1 | t2 | ... | tn <: f1 & f2 & ... & fn

Var(Interned<TypeVar>)

An opening type variable owing bounds.

Dict(Interned<RecordTy>)

A typst dictionary type.

Array(Interned<Ty>)

An array type.

Tuple(Interned<Vec<Ty>>)

A tuple type. Note: may contains spread types.

Func(Interned<SigTy>)

A function type.

Args(Interned<ArgsTy>)

An argument type.

Pattern(Interned<PatternTy>)

A pattern type.

With(Interned<SigWithTy>)

A partially applied function type.

Select(Interned<SelectTy>)

Select a field from a type.

Unary(Interned<TypeUnary>)

A unary operation.

Binary(Interned<TypeBinary>)

A binary operation.

If(Interned<IfTy>)

A conditional type.

Implementations

impl Ty

pub fn call( &self, args: &Interned<ArgsTy>, pol: bool, c: &mut impl ApplyChecker, )

Calls the given type with the given arguments.

pub fn tuple_element_of(&self, pol: bool, c: &mut impl ApplyChecker)

Gets the tuple element type of the given type.

pub fn element_of(&self, pol: bool, c: &mut impl ApplyChecker)

Get the element type of the given type.

impl Ty

pub fn has_bounds(&self) -> bool

Checks if the given type has bounds (is combinated).

pub fn as_source(&self) -> Option<DocSource>

Converts a type to doc source.

pub fn sources(&self) -> Vec<DocSource>

Gets the sources of the given type.

pub fn bounds(&self, pol: bool, checker: &mut impl BoundChecker)

Profiles the bounds of the given type.

impl Ty

pub fn from_cast_info(ty: &CastInfo) -> Ty

Converts a cast info to a type.

pub fn from_param_site(func: &Func, param: &ParamInfo) -> Ty

Converts a parameter site to a type.

impl Ty

pub fn is_dict(&self) -> bool

Whether the type is a dictionary type.

pub fn union(lhs: Option<Ty>, rhs: Option<Ty>) -> Option<Ty>

Creates a union type from two types.

pub fn from_types(iter: impl ExactSizeIterator<Item = Ty>) -> Self

Creates a union type from an iterator of types.

pub fn iter_union(iter: impl IntoIterator<Item = Ty>) -> Self

Creates a union type from an iterator of types.

pub const fn undef() -> Self

Creates an undefined type (which will emit an error). A that type is annotated if the syntax structure causes an type error.

pub fn name(&self) -> Interned<str>

Gets the name of the type.

pub fn span(&self) -> Span

Gets the span of the type.

pub fn value(&self) -> Option<Value>

Gets the value repr of the type.

pub fn element(&self) -> Option<Element>

Gets the element type.

pub fn satisfy<T: TyCtx>(&self, ctx: &T, f: impl FnMut(&Ty, bool))

Checks a type against a context.

pub fn is_content<T: TyCtx>(&self, ctx: &T) -> bool

Checks if the type is a content type.

pub fn is_str<T: TyCtx>(&self, ctx: &T) -> bool

Checks if the type is a string type.

pub fn is_type<T: TyCtx>(&self, ctx: &T) -> bool

Checks if the type is a type type.

impl Ty

pub fn repr(&self) -> Option<EcoString>

Describes the given type.

pub fn value_repr(&self) -> Option<EcoString>

Describes available value instances of the given type.

pub fn describe(&self) -> Option<EcoString>

Describe the given type.

impl Ty

pub fn iface_surface(&self, pol: bool, checker: &mut impl IfaceChecker)

Iterates over the signatures of the given type.

impl Ty

pub fn mutate(&self, pol: bool, checker: &mut impl TyMutator) -> Option<Ty>

Mutates the given type.

impl Ty

pub fn select( &self, key: &Interned<str>, pol: bool, checker: &mut impl SelectChecker, )

Selects the given type with the given key.

impl Ty

pub fn sig_surface( &self, pol: bool, sig_kind: SigSurfaceKind, checker: &mut impl SigChecker, )

Iterate over the signatures of the given type.

pub fn sig_repr( &self, pol: bool, ctx: &mut impl TyCtxMut, ) -> Option<Interned<SigTy>>

Get the signature representation of the given type.

Trait Implementations

impl Clone for Ty

fn clone(&self) -> Ty

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ty

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

Formats the value using the given formatter.

impl Hash for Ty

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 Internable for Ty

fn storage() -> &'static InternStorage<Self>

impl Ord for Ty

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

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

fn partial_cmp(&self, other: &Ty) -> 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 Eq for Ty

impl StructuralPartialEq for Ty