Struct Preamble 

pub struct Preamble<'a> {
    pub value: Value<'a>,
    pub source: Option<SourceSpan>,
}

A BibTeX preamble block.

Fields

value: Value<'a>

Expanded preamble value.

source: Option<SourceSpan>

Optional source location.

Implementations

impl<'a> Preamble<'a>

pub const fn new(value: Value<'a>) -> Self

Create a preamble block.

pub const fn value(&self) -> &Value<'a>

Return the preamble value.

pub fn into_owned(self) -> Preamble<'static>

Convert to an owned preamble.

Methods from Deref<Target = Value<'a>>

pub fn as_str(&self) -> Option<&str>

Get the value as a string (if it’s a simple literal)

pub fn expand(&self, strings: &AHashMap<&str, Value<'_>>) -> String

Expand variables and concatenations to get final string

pub fn to_plain_string(&self) -> String

Project this value to ordinary text without adding unresolved-variable markers.

Literals and numbers become their text form, variables become their variable name, and concatenations are joined recursively. This allocates when the value is not already a simple borrowed literal.

pub fn to_lossy_string(&self) -> String

Project this value to display text, marking unresolved variables as {name}.

pub fn to_bibtex_source(&self) -> String

Serialize this value as a BibTeX value fragment.

This is a normalized source projection. Use source-preserving parsing when callers need the exact original spelling or delimiters.

pub fn to_unicode_plain_string(&self) -> String

Project this value to ordinary text and convert common LaTeX sequences to Unicode.

Trait Implementations

impl<'a> Clone for Preamble<'a>

fn clone(&self) -> Preamble<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Preamble<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for Preamble<'a>

type Target = Value<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> PartialEq for Preamble<'a>

fn eq(&self, other: &Preamble<'a>) -> 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<'a> StructuralPartialEq for Preamble<'a>