Struct BibliographyDependency 

pub struct BibliographyDependency {
    path: ProjectPath,
    content: ContentHash,
}

A bibliography input paired with its content-hash boundary.

DependencyId::Bibliography answers which .bib file this is (its canonical ProjectPath); the paired [ContentHash] answers what was in it at build time. Together they are what a future incremental engine needs to decide that cached citation data is stale: the id is the cache slot, the content hash is the staleness check (design note §4.1, §7).

Construction guarantees the id is always the Bibliography variant, so a BibliographyDependency cannot be built over a source/asset/label identity by mistake: path and kind are therefore infallible.

The content hash is supplied by the caller rather than computed here, which keeps mos-cache free of any bibliography-format knowledge. Produce it from the source bytes with mos_bib::bibliography_content_hash; mos-eval (which reads the .bib and already depends on both crates) is the natural wiring point.

Examples

use mos_cache::{BibliographyDependency, DependencyId, DependencyKind};
use mos_core::ContentHash;

// The content hash would come from `mos_bib::bibliography_content_hash`.
let dep = BibliographyDependency::new("./refs.bib", ContentHash(0x1234))?;

assert_eq!(dep.kind(), DependencyKind::Bibliography);
assert_eq!(dep.id(), DependencyId::bibliography("refs.bib")?);
assert_eq!(dep.path().as_str(), "refs.bib");
assert_eq!(dep.content(), ContentHash(0x1234));

Fields

path: ProjectPath

content: ContentHash

Implementations

impl BibliographyDependency

pub fn new( path: impl AsRef<str>, content: ContentHash, ) -> Result<Self, ProjectPathError>

Pair a bibliography source path with the content hash of its bytes.

The path is canonicalized into a ProjectPath (§3.1), so logically equal paths yield equal dependencies; an invalid path returns ProjectPathError.

Errors

Returns ProjectPathError when path is not a valid project-relative path.

Examples

use mos_cache::BibliographyDependency;
use mos_core::ContentHash;

// `./ch/../refs.bib` and `refs.bib` canonicalize to one identity.
assert_eq!(
    BibliographyDependency::new("./ch/../refs.bib", ContentHash(7)),
    BibliographyDependency::new("refs.bib", ContentHash(7)),
);

pub fn id(&self) -> DependencyId

The typed dependency identity (always the Bibliography variant).

Examples

use mos_cache::{BibliographyDependency, DependencyId};
use mos_core::ContentHash;

let dep = BibliographyDependency::new("refs.bib", ContentHash(1))?;
assert_eq!(dep.id(), DependencyId::bibliography("refs.bib")?);

pub const fn path(&self) -> &ProjectPath

The canonical project path of the bibliography source.

Examples

use mos_cache::BibliographyDependency;
use mos_core::ContentHash;

assert_eq!(
    BibliographyDependency::new("refs.bib", ContentHash(1))?.path().as_str(),
    "refs.bib",
);

pub const fn content(&self) -> ContentHash

The content-hash boundary of the source bytes at build time.

Examples

use mos_cache::BibliographyDependency;
use mos_core::ContentHash;

assert_eq!(
    BibliographyDependency::new("refs.bib", ContentHash(42))?.content(),
    ContentHash(42),
);

pub const fn kind(&self) -> DependencyKind

The DependencyKind of this dependency: always Bibliography.

Examples

use mos_cache::{BibliographyDependency, DependencyKind};
use mos_core::ContentHash;

let dep = BibliographyDependency::new("refs.bib", ContentHash(1))?;
assert_eq!(dep.kind(), DependencyKind::Bibliography);

Trait Implementations

impl Clone for BibliographyDependency

fn clone(&self) -> BibliographyDependency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BibliographyDependency

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

Formats the value using the given formatter.

impl Eq for BibliographyDependency

impl Hash for BibliographyDependency

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 Ord for BibliographyDependency

fn cmp(&self, other: &BibliographyDependency) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BibliographyDependency

fn eq(&self, other: &BibliographyDependency) -> 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 PartialOrd for BibliographyDependency

fn partial_cmp(&self, other: &BibliographyDependency) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for BibliographyDependency