Struct LinebreakElem

pub struct LinebreakElem { /* private fields */ }

Inserts a line break.

Advances the paragraph to the next line. A single trailing line break at the end of a paragraph is ignored, but more than one creates additional empty lines.

Example

*Date:* 26.12.2022 \
*Topic:* Infrastructure Test \
*Severity:* High \

Syntax

This function also has dedicated syntax: To insert a line break, simply write a backslash followed by whitespace. This always creates an unjustified break.

Implementations

impl LinebreakElem

pub fn new() -> Self

Create a new instance of the element.

pub fn with_justify(self, justify: bool) -> Self

Builder-style setter for the justify field.

pub fn push_justify(&mut self, justify: bool)

Setter for the justify field.

pub fn justify(&self, styles: StyleChain<'_>) -> bool

Whether to justify the line before the break.

This is useful if you found a better line break opportunity in your justified text than Typst did.

#set par(justify: true)
#let jb = linebreak(justify: true)

I have manually tuned the #jb
line breaks in this paragraph #jb
for an _interesting_ result. #jb

pub fn justify_in(styles: StyleChain<'_>) -> bool

Access the justify field in the given style chain.

pub fn set_justify(justify: bool) -> Property

Create a style property for the justify field.

impl LinebreakElem

pub fn shared() -> &'static Content

Get the globally shared linebreak element.

Trait Implementations

impl Capable for LinebreakElem

fn vtable(capability: TypeId) -> Option<NonNull<()>>

Get the pointer to the vtable for the given capability / trait.

impl Clone for LinebreakElem

fn clone(&self) -> LinebreakElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for LinebreakElem

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

Construct an element from the arguments.

impl Debug for LinebreakElem

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

Formats the value using the given formatter.

impl Fields for LinebreakElem

type Enum = Fields

An enum with the fields of the element.

fn has(&self, id: u8) -> bool

Whether the element has the given field set.

fn field(&self, id: u8) -> Result<Value, FieldAccessError>

Get the field with the given field ID.

fn field_with_styles( &self, id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID in the presence of styles.

fn field_from_styles( id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID from the styles.

fn materialize(&mut self, styles: StyleChain<'_>)

Resolve all fields with the styles and save them in-place.

fn fields(&self) -> Dict

Get the fields of the element.

impl Hash for LinebreakElem

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 LinebreakElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for LinebreakElem

fn data() -> &'static NativeElementData

Get the element data for the native Rust element.

fn elem() -> Element

where Self: Sized,

Get the element for the native Rust element.

fn pack(self) -> Content

where Self: Sized,

Pack the element into type-erased content.

impl PartialEq for LinebreakElem

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

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

const 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 Repr for LinebreakElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for LinebreakElem

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

Parse relevant arguments into style properties for this element.