Struct CasesElem

pub struct CasesElem {
    pub children: Vec<Content>,
    /* private fields */
}

A case distinction.

Content across different branches can be aligned with the & symbol.

Example

$ f(x, y) := cases(
  1 "if" (x dot y)/2 <= 0,
  2 "if" x "is even",
  3 "if" x in NN,
  4 "else",
) $

Fields

children: Vec<Content>

Implementations

impl CasesElem

pub fn new(children: Vec<Content>) -> Self

Create a new instance of the element.

pub fn with_delim(self, delim: DelimiterPair) -> Self

Builder-style setter for the delim field.

pub fn with_reverse(self, reverse: bool) -> Self

Builder-style setter for the reverse field.

pub fn with_gap(self, gap: Rel<Length>) -> Self

Builder-style setter for the gap field.

pub fn push_delim(&mut self, delim: DelimiterPair)

Setter for the delim field.

pub fn push_reverse(&mut self, reverse: bool)

Setter for the reverse field.

pub fn push_gap(&mut self, gap: Rel<Length>)

Setter for the gap field.

pub fn delim(&self, styles: StyleChain<'_>) -> DelimiterPair

The delimiter to use.

Can be a single character specifying the left delimiter, in which case the right delimiter is inferred. Otherwise, can be an array containing a left and a right delimiter.

#set math.cases(delim: "[")
$ x = cases(1, 2) $

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

Whether the direction of cases should be reversed.

#set math.cases(reverse: true)
$ cases(1, 2) = x $

pub fn gap(&self, styles: StyleChain<'_>) -> <Rel<Length> as Resolve>::Output

The gap between branches.

#set math.cases(gap: 1em)
$ x = cases(1, 2) $

pub fn delim_in(styles: StyleChain<'_>) -> DelimiterPair

Access the delim field in the given style chain.

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

Access the reverse field in the given style chain.

pub fn gap_in(styles: StyleChain<'_>) -> <Rel<Length> as Resolve>::Output

Access the gap field in the given style chain.

pub fn set_delim(delim: DelimiterPair) -> Property

Create a style property for the delim field.

pub fn set_reverse(reverse: bool) -> Property

Create a style property for the reverse field.

pub fn set_gap(gap: Rel<Length>) -> Property

Create a style property for the gap field.

Trait Implementations

impl Capable for CasesElem

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

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

impl Clone for CasesElem

fn clone(&self) -> CasesElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for CasesElem

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

Construct an element from the arguments.

impl Debug for CasesElem

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

Formats the value using the given formatter.

impl Fields for CasesElem

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 CasesElem

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 CasesElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for CasesElem

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 CasesElem

fn eq(&self, other: &Self) -> 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 Repr for CasesElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for CasesElem

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

Parse relevant arguments into style properties for this element.