Enum Selector

pub enum Selector {
    Elem(Element, Option<SmallVec<[(u8, Value); 1]>>),
    Location(Location),
    Label(Label),
    Regex(Regex),
    Can(TypeId),
    Or(EcoVec<Selector>),
    And(EcoVec<Selector>),
    Before {
        selector: Arc<Selector>,
        end: Arc<Selector>,
        inclusive: bool,
    },
    After {
        selector: Arc<Selector>,
        start: Arc<Selector>,
        inclusive: bool,
    },
}

A filter for selecting elements within the document.

You can construct a selector in the following ways:

• you can use an element [function]
• you can filter for an element function with specific fields
• you can use a string or regular expression
• you can use a {<label>}
• you can use a [location]
• call the [selector] constructor to convert any of the above types into a selector value and use the methods below to refine it

Selectors are used to apply styling rules to elements. You can also use selectors to [query] the document for certain types of elements.

Furthermore, you can pass a selector to several of Typst’s built-in functions to configure their behaviour. One such example is the [outline] where it can be used to change which elements are listed within the outline.

Multiple selectors can be combined using the methods shown below. However, not all kinds of selectors are supported in all places, at the moment.

Example

#context query(
  heading.where(level: 1)
    .or(heading.where(level: 2))
)

= This will be found
== So will this
=== But this will not.

Variants

Elem(Element, Option<SmallVec<[(u8, Value); 1]>>)

Matches a specific type of element.

If there is a dictionary, only elements with the fields from the dictionary match.

Location(Location)

Matches the element at the specified location.

Label(Label)

Matches elements with a specific label.

Regex(Regex)

Matches text elements through a regular expression.

Can(TypeId)

Matches elements with a specific capability.

Or(EcoVec<Selector>)

Matches if any of the subselectors match.

And(EcoVec<Selector>)

Matches if all of the subselectors match.

Before

Matches all matches of selector before end.

Fields

selector: Arc<Selector>

end: Arc<Selector>

inclusive: bool

After

Matches all matches of selector after start.

Fields

selector: Arc<Selector>

start: Arc<Selector>

inclusive: bool

Implementations

impl Selector

pub fn text(text: &str) -> Result<Selector, EcoString>

Define a simple text selector.

pub fn regex(regex: Regex) -> Result<Selector, EcoString>

Define a regex selector.

pub fn can<T>() -> Selector

where T: Any + ?Sized,

Define a simple Selector::Can selector.

pub fn matches(&self, target: &Content, styles: Option<StyleChain<'_>>) -> bool

Whether the selector matches for the target.

impl Selector

pub fn construct(target: Selector) -> Selector

Turns a value into a selector. The following values are accepted:

• An element function like a heading or figure.
• A {<label>}.
• A more complex selector like {heading.where(level: 1)}.

pub fn or(self, others: Vec<Selector>) -> Selector

Selects all elements that match this or any of the other selectors.

pub fn and(self, others: Vec<Selector>) -> Selector

Selects all elements that match this and all of the other selectors.

pub fn before(self, end: LocatableSelector, inclusive: bool) -> Selector

Returns a modified selector that will only match elements that occur before the first match of end.

pub fn after(self, start: LocatableSelector, inclusive: bool) -> Selector

Returns a modified selector that will only match elements that occur after the first match of start.

Trait Implementations

impl Clone for Selector

fn clone(&self) -> Selector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Selector

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

Formats the value using the given formatter.

impl From<Location> for Selector

fn from(value: Location) -> Selector

Converts to this type from the input type.

impl FromValue for Selector

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

Try to cast the value into an instance of Self.

impl Hash for Selector

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 Selector

fn into_value(self) -> Value

Cast this type into a value.

impl NativeScope for Selector

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 Selector

const NAME: &'static str = "selector"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl PartialEq for Selector

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

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 Selector

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl StructuralPartialEq for Selector