Struct VecElem

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

A column vector.

Content in the vector’s elements can be aligned with the align parameter, or the & symbol.

Example

$ vec(a, b, c) dot vec(1, 2, 3)
    = a + 2b + 3c $

Fields

children: Vec<Content>

Implementations

impl VecElem

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_align(self, align: HAlignment) -> Self

Builder-style setter for the align 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_align(&mut self, align: HAlignment)

Setter for the align 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.vec(delim: "[")
$ vec(1, 2) $

pub fn align(&self, styles: StyleChain<'_>) -> <HAlignment as Resolve>::Output

The horizontal alignment that each element should have.

#set math.vec(align: right)
$ vec(-1, 1, -1) $

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

The gap between elements.

#set math.vec(gap: 1em)
$ vec(1, 2) $

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

Access the delim field in the given style chain.

pub fn align_in(styles: StyleChain<'_>) -> <HAlignment as Resolve>::Output

Access the align 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_align(align: HAlignment) -> Property

Create a style property for the align field.

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

Create a style property for the gap field.

Trait Implementations

impl Capable for VecElem

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

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

impl Clone for VecElem

fn clone(&self) -> VecElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for VecElem

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

Construct an element from the arguments.

impl Debug for VecElem

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

Formats the value using the given formatter.

impl Fields for VecElem

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 VecElem

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 VecElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for VecElem

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 VecElem

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 VecElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for VecElem

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

Parse relevant arguments into style properties for this element.