Struct CitationItem

pub struct CitationItem<'a, T: EntryLike> {
    pub entry: &'a T,
    pub locator: Option<SpecificLocator<'a>>,
    pub locale: Option<LocaleCode>,
    pub hidden: bool,
    pub purpose: Option<CitePurpose>,
    /* private fields */
}

A reference to an crate::Entry within a CitationRequest.

Fields

entry: &'a T

The entry to format.

locator: Option<SpecificLocator<'a>>

The locator that specifies where in the entry the item is found.

locale: Option<LocaleCode>

A locale code that overrides the assumed locale of the entry. If this is none, this will default to CitationRequest::locale and then citationberg::IndependentStyle::default_locale.

hidden: bool

Whether this item will be included in the output.

purpose: Option<CitePurpose>

Format the item in a special way.

Implementations

impl<'a, T: EntryLike> CitationItem<'a, T>

pub fn with_entry(entry: &'a T) -> Self

Create a new citation item for the given entry.

pub fn with_locator(entry: &'a T, locator: Option<SpecificLocator<'a>>) -> Self

Create a new citation item with a locator for the given entry.

pub fn new( entry: &'a T, locator: Option<SpecificLocator<'a>>, locale: Option<LocaleCode>, hidden: bool, purpose: Option<CitePurpose>, ) -> Self

Create a new citation with all fields set.

pub fn kind(self, purpose: CitePurpose) -> Self

Change the kind of this item.

Trait Implementations

impl<'a, T: Clone + EntryLike> Clone for CitationItem<'a, T>

fn clone(&self) -> CitationItem<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug + EntryLike> Debug for CitationItem<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: Hash + EntryLike> Hash for CitationItem<'a, T>

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<'a, T: PartialEq + EntryLike> PartialEq for CitationItem<'a, T>

fn eq(&self, other: &CitationItem<'a, 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<'a, T: Eq + EntryLike> Eq for CitationItem<'a, T>

impl<'a, T: EntryLike> StructuralPartialEq for CitationItem<'a, T>