Struct RawElem 

pub struct RawElem {
    pub text: RawContent,
    pub block: Settable<Self, 1u8>,
    pub lang: Settable<Self, 2u8>,
    pub align: Settable<Self, 3u8>,
    pub syntaxes: Settable<Self, 4u8>,
    pub theme: Settable<Self, 5u8>,
    pub tab_size: Settable<Self, 6u8>,
    pub lines: Option<Vec<Packed<RawLine>>>,
}

Raw text with optional syntax highlighting.

Displays the text verbatim and in a monospace font. This is typically used to embed computer code into your document.

Note that text given to this element cannot contain arbitrary formatting, such as [*strong*] or [_emphasis_], as it is displayed verbatim. If you’d like to display any kind of content with a monospace font, instead of using [raw], you should change its font to a monospace font using the text function.

Example

Adding `rbx` to `rcx` gives
the desired result.

What is ```rust fn main()``` in Rust
would be ```c int main()``` in C.

```rust
fn main() {
    println!("Hello World!");
}
```

This has ``` `backticks` ``` in it
(but the spaces are trimmed). And
``` here``` the leading space is
also trimmed.

You can also construct a [raw] element programmatically from a string (and provide the language tag via the optional lang argument).

#raw("fn " + "main() {}", lang: "rust")

Syntax

This function also has dedicated syntax. You can enclose text in 1 or 3+ backticks (`) to make it raw. Two backticks produce empty raw text. This works both in markup and code.

When you use three or more backticks, you can additionally specify a language tag for syntax highlighting directly after the opening backticks. Within raw blocks, everything (except for the language tag, if applicable) is rendered as is, in particular, there are no escape sequences.

The language tag is an identifier that directly follows the opening backticks only if there are three or more backticks. If your text starts with something that looks like an identifier, but no syntax highlighting is needed, start the text with a single space (which will be trimmed) or use the single backtick syntax. If your text should start or end with a backtick, put a space before or after it (it will be trimmed).

If no syntax highlighting is available by default for your specified language tag (or if you want to override the built-in definition), you may provide a custom syntax specification file to the syntaxes field.

Styling

By default, the raw element uses the DejaVu Sans Mono font (included with Typst), with a smaller font size of {0.8em} (that is, 80% of the global font size). This is because monospace fonts tend to be visually larger than non-monospace fonts.

You can customize these properties with show-set rules:

// Switch to Cascadia Code for both
// inline and block raw.
#show raw: set text(font: "Cascadia Code")

// Reset raw blocks to the same size as normal text,
// but keep inline raw at the reduced size.
#show raw.where(block: true): set text(1em / 0.8)

Now using the `Cascadia Code` font for raw text.
Here's some Python code. It looks larger now:

```py
def python():
  return 5 + 5
```

In addition, you can customize the syntax highlighting colors by setting a custom theme through the theme field.

For complete customization of the appearance of a raw block, a show rule on raw.line could be helpful, such as to add line numbers.

Note that, in raw text, typesetting features like hyphenation, overhang, CJK-Latin spacing (and justification for raw blocks) will be disabled by default.

Fields

text: RawContent

block: Settable<Self, 1u8>

lang: Settable<Self, 2u8>

align: Settable<Self, 3u8>

syntaxes: Settable<Self, 4u8>

theme: Settable<Self, 5u8>

tab_size: Settable<Self, 6u8>

lines: Option<Vec<Packed<RawLine>>>

Implementations

impl RawElem

pub fn new(text: RawContent) -> Self

Create a new instance of the element.

pub fn with_block(self, block: bool) -> Self

Builder-style setter for the block field.

pub fn with_lang(self, lang: Option<EcoString>) -> Self

Builder-style setter for the lang field.

pub fn with_align(self, align: HAlignment) -> Self

Builder-style setter for the align field.

pub fn with_syntaxes( self, syntaxes: Derived<OneOrMultiple<DataSource>, Vec<RawSyntax>>, ) -> Self

Builder-style setter for the syntaxes field.

pub fn with_theme( self, theme: Smart<Option<Derived<DataSource, RawTheme>>>, ) -> Self

Builder-style setter for the theme field.

pub fn with_tab_size(self, tab_size: usize) -> Self

Builder-style setter for the tab-size field.

pub fn with_lines(self, lines: Vec<Packed<RawLine>>) -> Self

Builder-style setter for the lines field.

impl RawElem

pub const text: Field<Self, 0u8>

pub const block: Field<Self, 1u8>

pub const lang: Field<Self, 2u8>

pub const align: Field<Self, 3u8>

pub const syntaxes: Field<Self, 4u8>

pub const theme: Field<Self, 5u8>

pub const tab_size: Field<Self, 6u8>

pub const lines: Field<Self, 7u8>

impl RawElem

pub fn languages() -> Vec<(&'static str, Vec<&'static str>)>

The supported language names and tags.

Trait Implementations

impl Clone for RawElem

fn clone(&self) -> RawElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for RawElem

fn construct(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Content>

Construct an element from the arguments.

impl Debug for RawElem

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

Formats the value using the given formatter.

impl Hash for RawElem

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 NativeElement for RawElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl NativeScope for RawElem

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

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl RequiredField<0> for RawElem

const FIELD: RequiredFieldData<Self, 0u8>

type Type = RawContent

impl Set for RawElem

fn set(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Styles>

Parse relevant arguments into style properties for this element.

impl SettableField<1> for RawElem

const FIELD: SettableFieldData<Self, 1u8>

type Type = bool

impl SettableField<2> for RawElem

const FIELD: SettableFieldData<Self, 2u8>

type Type = Option<EcoString>

impl SettableField<3> for RawElem

const FIELD: SettableFieldData<Self, 3u8>

type Type = HAlignment

impl SettableField<4> for RawElem

const FIELD: SettableFieldData<Self, 4u8>

type Type = Derived<OneOrMultiple<DataSource>, Vec<RawSyntax>>

impl SettableField<5> for RawElem

const FIELD: SettableFieldData<Self, 5u8>

type Type = Smart<Option<Derived<DataSource, RawTheme>>>

impl SettableField<6> for RawElem

const FIELD: SettableFieldData<Self, 6u8>

type Type = usize

impl SynthesizedField<7> for RawElem

const FIELD: SynthesizedFieldData<Self, 7u8>

type Type = Vec<Packed<RawLine>>

impl RefableProperty<1> for RawElem

impl RefableProperty<2> for RawElem

impl RefableProperty<3> for RawElem

impl RefableProperty<5> for RawElem

impl RefableProperty<6> for RawElem