Struct Packed

pub struct Packed<T>(/* private fields */)
where
    T: NativeElement;

A packed element of a static type.

Implementations

impl<T> Packed<T>

where T: NativeElement,

pub fn new(element: T) -> Packed<T>

Pack element while retaining its static type.

pub fn from_ref(content: &Content) -> Option<&Packed<T>>

Try to cast type-erased content into a statically known packed element.

pub fn from_mut(content: &mut Content) -> Option<&mut Packed<T>>

Try to cast type-erased content into a statically known packed element.

pub fn from_owned(content: Content) -> Result<Packed<T>, Content>

Try to cast type-erased content into a statically known packed element.

pub fn pack(self) -> Content

Pack back into content.

pub fn pack_ref(&self) -> &Content

Pack back into a reference to content.

pub fn pack_mut(&mut self) -> &mut Content

Pack back into a mutable reference to content.

pub fn unpack(self) -> T

Extract the raw underlying element.

pub fn span(&self) -> Span

The element’s span.

pub fn spanned(self, span: Span) -> Packed<T>

Set the span of the element.

pub fn label(&self) -> Option<Label>

Accesses the label of the element.

pub fn location(&self) -> Option<Location>

Accesses the location of the element.

pub fn set_location(&mut self, location: Location)

Sets the location of the element.

impl Packed<InlineElem>

pub fn layout( &self, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Axes<Abs>, ) -> Result<Vec<InlineItem>, EcoVec<SourceDiagnostic>>

Layout the element.

impl Packed<AttachElem>

pub fn merge_base(&self) -> Option<Packed<AttachElem>>

If an AttachElem’s base is also an AttachElem, merge attachments into the base AttachElem where possible.

impl Packed<BibliographyElem>

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

Produces the heading for the bibliography, if any.

impl Packed<CiteGroup>

pub fn realize( &self, engine: &mut Engine<'_>, ) -> Result<Content, EcoVec<SourceDiagnostic>>

impl Packed<FootnoteElem>

pub fn realize( &self, engine: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<(Destination, Content), EcoVec<SourceDiagnostic>>

Returns the linking location and the resolved numbers.

pub fn declaration_location( &self, engine: &Engine<'_>, ) -> Result<Location, EcoString>

Returns the location of the definition of this footnote.

impl Packed<FootnoteEntry>

pub fn realize( &self, engine: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<(Content, Content), EcoVec<SourceDiagnostic>>

Returns the location which should be attached to the entry, the linking destination, the resolved numbers, and the body content.

impl Packed<OutlineElem>

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

Produces the heading for the outline, if any.

pub fn realize_flat( &self, engine: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<Vec<Packed<OutlineEntry>>, EcoVec<SourceDiagnostic>>

Realizes the entries in a flat fashion.

pub fn realize_tree( &self, engine: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<Vec<OutlineNode>, EcoVec<SourceDiagnostic>>

Realizes the entries in a tree fashion.

impl Packed<RefElem>

pub fn realize( &self, engine: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<Content, EcoVec<SourceDiagnostic>>

Realize as a linked, textual reference.

impl Packed<ImageElem>

pub fn decode( &self, engine: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<Image, EcoVec<SourceDiagnostic>>

Decodes the image.

Trait Implementations

impl<T> AsMut<T> for Packed<T>

where T: NativeElement,

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<T> for Packed<T>

where T: NativeElement,

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Clone for Packed<T>

where T: Clone + NativeElement,

fn clone(&self) -> Packed<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Count for Packed<CounterUpdateElem>

fn update(&self) -> Option<CounterUpdate>

Get the counter update for this element.

impl Count for Packed<EquationElem>

fn update(&self) -> Option<CounterUpdate>

Get the counter update for this element.

impl Count for Packed<FigureElem>

fn update(&self) -> Option<CounterUpdate>

Get the counter update for this element.

impl Count for Packed<FootnoteElem>

fn update(&self) -> Option<CounterUpdate>

Get the counter update for this element.

impl Count for Packed<HeadingElem>

fn update(&self) -> Option<CounterUpdate>

Get the counter update for this element.

impl Count for Packed<ParLineMarker>

fn update(&self) -> Option<CounterUpdate>

Get the counter update for this element.

impl<T> Debug for Packed<T>

where T: NativeElement + Debug,

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

Formats the value using the given formatter.

impl Default for Packed<GridCell>

fn default() -> Packed<GridCell>

Returns the “default value” for a type.

impl Default for Packed<TableCell>

fn default() -> Packed<TableCell>

Returns the “default value” for a type.

impl<T> Deref for Packed<T>

where T: NativeElement,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Packed<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for Packed<T>

where T: NativeElement,

fn deref_mut(&mut self) -> &mut <Packed<T> as Deref>::Target

Mutably dereferences the value.

impl<T> FromValue for Packed<T>

where T: NativeElement + FromValue,

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

Try to cast the value into an instance of Self.

impl<T> Hash for Packed<T>

where T: NativeElement,

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<T> IntoValue for Packed<T>

where T: NativeElement + IntoValue,

fn into_value(self) -> Value

Cast this type into a value.

impl LocalName for Packed<BibliographyElem>

const KEY: &'static str = "bibliography"

The key of an element in order to get its localized name.

fn local_name(lang: Lang, region: Option<Region>) -> &'static str

Get the name in the given language and (optionally) region.

fn local_name_in(styles: StyleChain<'_>) -> &'static str

where Self: Sized,

Gets the local name from the style chain.

impl LocalName for Packed<EquationElem>

const KEY: &'static str = "equation"

The key of an element in order to get its localized name.

fn local_name(lang: Lang, region: Option<Region>) -> &'static str

Get the name in the given language and (optionally) region.

fn local_name_in(styles: StyleChain<'_>) -> &'static str

where Self: Sized,

Gets the local name from the style chain.

impl LocalName for Packed<FootnoteElem>

const KEY: &'static str = "footnote"

The key of an element in order to get its localized name.

fn local_name(lang: Lang, region: Option<Region>) -> &'static str

Get the name in the given language and (optionally) region.

fn local_name_in(styles: StyleChain<'_>) -> &'static str

where Self: Sized,

Gets the local name from the style chain.

impl LocalName for Packed<HeadingElem>

const KEY: &'static str = "heading"

The key of an element in order to get its localized name.

fn local_name(lang: Lang, region: Option<Region>) -> &'static str

Get the name in the given language and (optionally) region.

fn local_name_in(styles: StyleChain<'_>) -> &'static str

where Self: Sized,

Gets the local name from the style chain.

impl LocalName for Packed<ImageElem>

const KEY: &'static str = "figure"

The key of an element in order to get its localized name.

fn local_name(lang: Lang, region: Option<Region>) -> &'static str

Get the name in the given language and (optionally) region.

fn local_name_in(styles: StyleChain<'_>) -> &'static str

where Self: Sized,

Gets the local name from the style chain.

impl LocalName for Packed<OutlineElem>

const KEY: &'static str = "outline"

The key of an element in order to get its localized name.

fn local_name(lang: Lang, region: Option<Region>) -> &'static str

Get the name in the given language and (optionally) region.

fn local_name_in(styles: StyleChain<'_>) -> &'static str

where Self: Sized,

Gets the local name from the style chain.

impl LocalName for Packed<RawElem>

const KEY: &'static str = "raw"

The key of an element in order to get its localized name.

fn local_name(lang: Lang, region: Option<Region>) -> &'static str

Get the name in the given language and (optionally) region.

fn local_name_in(styles: StyleChain<'_>) -> &'static str

where Self: Sized,

Gets the local name from the style chain.

impl LocalName for Packed<TableElem>

const KEY: &'static str = "table"

The key of an element in order to get its localized name.

fn local_name(lang: Lang, region: Option<Region>) -> &'static str

Get the name in the given language and (optionally) region.

fn local_name_in(styles: StyleChain<'_>) -> &'static str

where Self: Sized,

Gets the local name from the style chain.

impl Outlinable for Packed<EquationElem>

fn outlined(&self) -> bool

Whether this element should be included in the outline.

fn prefix(&self, numbers: Content) -> Content

Constructs the default prefix given the formatted numbering.

fn body(&self) -> Content

The body of the entry.

fn level(&self) -> NonZero<usize>

The nesting level of this element.

impl Outlinable for Packed<FigureElem>

fn outlined(&self) -> bool

Whether this element should be included in the outline.

fn prefix(&self, numbers: Content) -> Content

Constructs the default prefix given the formatted numbering.

fn body(&self) -> Content

The body of the entry.

fn level(&self) -> NonZero<usize>

The nesting level of this element.

impl Outlinable for Packed<HeadingElem>

fn outlined(&self) -> bool

Whether this element should be included in the outline.

fn level(&self) -> NonZero<usize>

The nesting level of this element.

fn prefix(&self, numbers: Content) -> Content

Constructs the default prefix given the formatted numbering.

fn body(&self) -> Content

The body of the entry.

impl<T> PartialEq for Packed<T>

where T: NativeElement,

fn eq(&self, other: &Packed<T>) -> 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 PlainText for Packed<RawElem>

fn plain_text(&self, text: &mut EcoString)

Write this element’s plain text into the given buffer.

impl PlainText for Packed<RawLine>

fn plain_text(&self, text: &mut EcoString)

Write this element’s plain text into the given buffer.

impl PlainText for Packed<SmartQuoteElem>

fn plain_text(&self, text: &mut EcoString)

Write this element’s plain text into the given buffer.

impl PlainText for Packed<SpaceElem>

fn plain_text(&self, text: &mut EcoString)

Write this element’s plain text into the given buffer.

impl PlainText for Packed<SymbolElem>

fn plain_text(&self, text: &mut EcoString)

Write this element’s plain text into the given buffer.

impl PlainText for Packed<TextElem>

fn plain_text(&self, text: &mut EcoString)

Write this element’s plain text into the given buffer.

impl Refable for Packed<EquationElem>

fn supplement(&self) -> Content

The supplement, if not overridden by the reference.

fn counter(&self) -> Counter

Returns the counter of this element.

fn numbering(&self) -> Option<&Numbering>

Returns the numbering of this element.

impl Refable for Packed<FigureElem>

fn supplement(&self) -> Content

The supplement, if not overridden by the reference.

fn counter(&self) -> Counter

Returns the counter of this element.

fn numbering(&self) -> Option<&Numbering>

Returns the numbering of this element.

impl Refable for Packed<HeadingElem>

fn supplement(&self) -> Content

The supplement, if not overridden by the reference.

fn counter(&self) -> Counter

Returns the counter of this element.

fn numbering(&self) -> Option<&Numbering>

Returns the numbering of this element.

impl<T> Reflect for Packed<T>

where T: NativeElement + Reflect,

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 ResolvableCell for Packed<GridCell>

fn resolve_cell( self, x: usize, y: usize, fill: &Option<Paint>, align: Smart<Alignment>, inset: Sides<Option<Rel>>, stroke: Sides<Option<Option<Arc<Stroke<Abs>>>>>, breakable: bool, styles: StyleChain<'_>, _: Smart<TableCellKind>, ) -> Cell

Resolves the cell’s fields, given its coordinates and default grid-wide fill, align, inset and stroke properties, plus the expected value of the breakable field. Returns a final Cell.

fn x(&self, styles: StyleChain<'_>) -> Smart<usize>

Returns this cell’s column override.

fn y(&self, styles: StyleChain<'_>) -> Smart<usize>

Returns this cell’s row override.

fn colspan(&self, styles: StyleChain<'_>) -> NonZero<usize>

The amount of columns spanned by this cell.

fn rowspan(&self, styles: StyleChain<'_>) -> NonZero<usize>

The amount of rows spanned by this cell.

fn span(&self) -> Span

The cell’s span, for errors.

impl ResolvableCell for Packed<TableCell>

fn resolve_cell( self, x: usize, y: usize, fill: &Option<Paint>, align: Smart<Alignment>, inset: Sides<Option<Rel>>, stroke: Sides<Option<Option<Arc<Stroke<Abs>>>>>, breakable: bool, styles: StyleChain<'_>, kind: Smart<TableCellKind>, ) -> Cell

Resolves the cell’s fields, given its coordinates and default grid-wide fill, align, inset and stroke properties, plus the expected value of the breakable field. Returns a final Cell.

fn x(&self, styles: StyleChain<'_>) -> Smart<usize>

Returns this cell’s column override.

fn y(&self, styles: StyleChain<'_>) -> Smart<usize>

Returns this cell’s row override.

fn colspan(&self, styles: StyleChain<'_>) -> NonZero<usize>

The amount of columns spanned by this cell.

fn rowspan(&self, styles: StyleChain<'_>) -> NonZero<usize>

The amount of rows spanned by this cell.

fn span(&self) -> Span

The cell’s span, for errors.

impl ShowSet for Packed<BibliographyElem>

fn show_set(&self, _: StyleChain<'_>) -> Styles

Finalize the fully realized form of the element. Use this for effects that should work even in the face of a user-defined show rule.

impl ShowSet for Packed<EquationElem>

fn show_set(&self, styles: StyleChain<'_>) -> Styles

Finalize the fully realized form of the element. Use this for effects that should work even in the face of a user-defined show rule.

impl ShowSet for Packed<FigureElem>

fn show_set(&self, _: StyleChain<'_>) -> Styles

Finalize the fully realized form of the element. Use this for effects that should work even in the face of a user-defined show rule.

impl ShowSet for Packed<FootnoteEntry>

fn show_set(&self, _: StyleChain<'_>) -> Styles

Finalize the fully realized form of the element. Use this for effects that should work even in the face of a user-defined show rule.

impl ShowSet for Packed<HeadingElem>

fn show_set(&self, styles: StyleChain<'_>) -> Styles

Finalize the fully realized form of the element. Use this for effects that should work even in the face of a user-defined show rule.

impl ShowSet for Packed<LinkElem>

fn show_set(&self, _: StyleChain<'_>) -> Styles

Finalize the fully realized form of the element. Use this for effects that should work even in the face of a user-defined show rule.

impl ShowSet for Packed<OutlineElem>

fn show_set(&self, styles: StyleChain<'_>) -> Styles

Finalize the fully realized form of the element. Use this for effects that should work even in the face of a user-defined show rule.

impl ShowSet for Packed<QuoteElem>

fn show_set(&self, styles: StyleChain<'_>) -> Styles

Finalize the fully realized form of the element. Use this for effects that should work even in the face of a user-defined show rule.

impl ShowSet for Packed<RawElem>

fn show_set(&self, styles: StyleChain<'_>) -> Styles

Finalize the fully realized form of the element. Use this for effects that should work even in the face of a user-defined show rule.

impl ShowSet for Packed<TitleElem>

fn show_set(&self, _styles: StyleChain<'_>) -> Styles

Finalize the fully realized form of the element. Use this for effects that should work even in the face of a user-defined show rule.

impl Synthesize for Packed<BibliographyElem>

fn synthesize( &mut self, _: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<(), EcoVec<SourceDiagnostic>>

Prepare the element for show rule application.

impl Synthesize for Packed<CiteElem>

fn synthesize( &mut self, _: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<(), EcoVec<SourceDiagnostic>>

Prepare the element for show rule application.

impl Synthesize for Packed<EquationElem>

fn synthesize( &mut self, engine: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<(), EcoVec<SourceDiagnostic>>

Prepare the element for show rule application.

impl Synthesize for Packed<FigureCaption>

fn synthesize( &mut self, _: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<(), EcoVec<SourceDiagnostic>>

Prepare the element for show rule application.

impl Synthesize for Packed<FigureElem>

fn synthesize( &mut self, engine: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<(), EcoVec<SourceDiagnostic>>

Prepare the element for show rule application.

impl Synthesize for Packed<GridElem>

fn synthesize( &mut self, engine: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<(), EcoVec<SourceDiagnostic>>

Prepare the element for show rule application.

impl Synthesize for Packed<HeadingElem>

fn synthesize( &mut self, engine: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<(), EcoVec<SourceDiagnostic>>

Prepare the element for show rule application.

impl Synthesize for Packed<ImageElem>

fn synthesize( &mut self, _: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<(), EcoVec<SourceDiagnostic>>

Prepare the element for show rule application.

impl Synthesize for Packed<RawElem>

fn synthesize( &mut self, engine: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<(), EcoVec<SourceDiagnostic>>

Prepare the element for show rule application.

impl Synthesize for Packed<RefElem>

fn synthesize( &mut self, engine: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<(), EcoVec<SourceDiagnostic>>

Prepare the element for show rule application.

impl Synthesize for Packed<TableElem>

fn synthesize( &mut self, engine: &mut Engine<'_>, styles: StyleChain<'_>, ) -> Result<(), EcoVec<SourceDiagnostic>>

Prepare the element for show rule application.

impl Figurable for Packed<ImageElem>

impl Figurable for Packed<RawElem>

impl Figurable for Packed<TableElem>

impl Locatable for Packed<AttachElem>

impl Locatable for Packed<BibliographyElem>

impl Locatable for Packed<CiteElem>

impl Locatable for Packed<CiteGroup>

impl Locatable for Packed<ContextElem>

impl Locatable for Packed<CounterDisplayElem>

impl Locatable for Packed<CounterUpdateElem>

impl Locatable for Packed<EmphElem>

impl Locatable for Packed<EnumElem>

impl Locatable for Packed<EquationElem>

impl Locatable for Packed<FigureCaption>

impl Locatable for Packed<FigureElem>

impl Locatable for Packed<FootnoteElem>

impl Locatable for Packed<FootnoteEntry>

impl Locatable for Packed<FootnoteMarker>

impl Locatable for Packed<HeadingElem>

impl Locatable for Packed<HighlightElem>

impl Locatable for Packed<ImageElem>

impl Locatable for Packed<LayoutElem>

impl Locatable for Packed<LinkElem>

impl Locatable for Packed<ListElem>

impl Locatable for Packed<MetadataElem>

impl Locatable for Packed<OutlineElem>

impl Locatable for Packed<OutlineEntry>

impl Locatable for Packed<OverlineElem>

impl Locatable for Packed<ParElem>

impl Locatable for Packed<ParLine>

impl Locatable for Packed<ParLineMarker>

impl Locatable for Packed<PlaceElem>

impl Locatable for Packed<PrefixInfo>

impl Locatable for Packed<QuoteElem>

impl Locatable for Packed<RawElem>

impl Locatable for Packed<RefElem>

impl Locatable for Packed<StateUpdateElem>

impl Locatable for Packed<StrikeElem>

impl Locatable for Packed<StrongElem>

impl Locatable for Packed<TableElem>

impl Locatable for Packed<TermsElem>

impl Locatable for Packed<TitleElem>

impl Locatable for Packed<UnderlineElem>

impl Mathy for Packed<AccentElem>

impl Mathy for Packed<AlignPointElem>

impl Mathy for Packed<AttachElem>

impl Mathy for Packed<BinomElem>

impl Mathy for Packed<CancelElem>

impl Mathy for Packed<CasesElem>

impl Mathy for Packed<ClassElem>

impl Mathy for Packed<FracElem>

impl Mathy for Packed<LimitsElem>

impl Mathy for Packed<LrElem>

impl Mathy for Packed<MatElem>

impl Mathy for Packed<MidElem>

impl Mathy for Packed<OpElem>

impl Mathy for Packed<OverbraceElem>

impl Mathy for Packed<OverbracketElem>

impl Mathy for Packed<OverlineElem>

impl Mathy for Packed<OverparenElem>

impl Mathy for Packed<OvershellElem>

impl Mathy for Packed<PrimesElem>

impl Mathy for Packed<RootElem>

impl Mathy for Packed<ScriptsElem>

impl Mathy for Packed<StretchElem>

impl Mathy for Packed<UnderbraceElem>

impl Mathy for Packed<UnderbracketElem>

impl Mathy for Packed<UnderlineElem>

impl Mathy for Packed<UnderparenElem>

impl Mathy for Packed<UndershellElem>

impl Mathy for Packed<VecElem>

impl Tagged for Packed<ArtifactElem>

impl Tagged for Packed<EmphElem>

impl Tagged for Packed<EnumElem>

impl Tagged for Packed<EnumItem>

impl Tagged for Packed<EquationElem>

impl Tagged for Packed<FigureCaption>

impl Tagged for Packed<FigureElem>

impl Tagged for Packed<FootnoteElem>

impl Tagged for Packed<FootnoteEntry>

impl Tagged for Packed<GridElem>

impl Tagged for Packed<HeadingElem>

impl Tagged for Packed<HideElem>

impl Tagged for Packed<HighlightElem>

impl Tagged for Packed<ImageElem>

impl Tagged for Packed<LinkMarker>

impl Tagged for Packed<ListElem>

impl Tagged for Packed<ListItem>

impl Tagged for Packed<OutlineElem>

impl Tagged for Packed<OutlineEntry>

impl Tagged for Packed<OverlineElem>

impl Tagged for Packed<ParElem>

impl Tagged for Packed<PdfMarkerTag>

impl Tagged for Packed<PlaceElem>

impl Tagged for Packed<QuoteElem>

impl Tagged for Packed<RawElem>

impl Tagged for Packed<RawLine>

impl Tagged for Packed<RefElem>

impl Tagged for Packed<RepeatElem>

impl Tagged for Packed<StrikeElem>

impl Tagged for Packed<StrongElem>

impl Tagged for Packed<SubElem>

impl Tagged for Packed<SuperElem>

impl Tagged for Packed<TableElem>

impl Tagged for Packed<TermItem>

impl Tagged for Packed<TermsElem>

impl Tagged for Packed<TitleElem>

impl Tagged for Packed<UnderlineElem>

impl Unlabellable for Packed<ParbreakElem>

impl Unlabellable for Packed<SpaceElem>

impl Unlabellable for Packed<TagElem>

impl Unqueriable for Packed<CounterDisplayElem>

impl Unqueriable for Packed<ParLineMarker>

impl Unqueriable for Packed<PlaceElem>

impl Unqueriable for Packed<PrefixInfo>