Skip to main content

ParsedItem

Enum ParsedItem 

Source
pub enum ParsedItem<'a> {
    Entry(Entry<'a>),
    String(&'a str, Value<'a>),
    Preamble(Value<'a>),
    Comment(&'a str),
}
Expand description

A raw parsed item from a BibTeX file before processing

This represents the different types of items that can appear in a BibTeX file, returned by the low-level parse_bibtex() function. These items are in their raw parsed form:

  • String variables are not yet expanded
  • Field values preserve concatenation structure
  • Comments are preserved exactly as found
  • All items maintain their original order

§Examples

use bibtex_parser::parser::{parse_bibtex, ParsedItem};

let input = "@string{name = \"John\"}\n@article{key, author = name}";
let items = parse_bibtex(input)?;

match &items[0] {
    ParsedItem::String(var_name, value) => {
        println!("String variable: {} = {:?}", var_name, value);
    },
    _ => {}
}

match &items[1] {
    ParsedItem::Entry(entry) => {
        // The author field contains a variable reference, not the expanded value
        println!("Entry key: {}", entry.key());
    },
    _ => {}
}

Variants§

§

Entry(Entry<'a>)

A bibliography entry (article, book, inproceedings, etc.)

Contains the entry in its raw parsed form with field values that may reference string variables or contain concatenations.

§

String(&'a str, Value<'a>)

A string definition (@string{name = value})

Contains the variable name and its value. The value itself may contain references to other string variables or concatenations.

§

Preamble(Value<'a>)

A preamble (@preamble{value})

Contains the preamble value, which may reference string variables or contain concatenations.

§

Comment(&'a str)

A comment (both % line comment and @comment{...})

Contains the raw comment text exactly as it appears in the source, including any whitespace and formatting.

Trait Implementations§

Source§

impl<'a> Clone for ParsedItem<'a>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for ParsedItem<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> PartialEq for ParsedItem<'a>

Source§

fn eq(&self, other: &ParsedItem<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'a> StructuralPartialEq for ParsedItem<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for ParsedItem<'a>

§

impl<'a> RefUnwindSafe for ParsedItem<'a>

§

impl<'a> Send for ParsedItem<'a>

§

impl<'a> Sync for ParsedItem<'a>

§

impl<'a> Unpin for ParsedItem<'a>

§

impl<'a> UnsafeUnpin for ParsedItem<'a>

§

impl<'a> UnwindSafe for ParsedItem<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Ungil for T
where T: Send,