Skip to main content

BibLockfile

Struct BibLockfile 

Source
pub struct BibLockfile {
    pub question_id: String,
    pub reader: String,
    pub shortlist_hash: String,
    pub content_hash: String,
    pub scitadel_version: String,
    pub algo_hash: String,
    pub format: String,
    pub format_version: String,
    pub generated_at: String,
}
Expand description

Sidecar JSON written next to the exported .bib (path = <output>.scitadel-bib.lock). One sidecar per output file — per-question scope means several may live in one repo.

Fields§

§question_id: String

Research question this snapshot was scoped to.

§reader: String

Reader identity at snapshot time. Mirrors annotation/star scoping — different readers may produce different shortlists.

§shortlist_hash: String

SHA-256 of the lex-sorted paper_id\n list. The drift anchor.

§content_hash: String

SHA-256 of the emitted .bib bytes. Cheap re-emit skip.

§scitadel_version: String

scitadel binary version that produced this snapshot. Drives the stale exit code when the binary moves forward.

§algo_hash: String

Pinned key-generation algorithm hash from ADR-006. Drives the stale exit code when the algorithm itself drifts.

§format: String

Output flavor — "bibtex" here. #135 adds "csl-json".

§format_version: String

Schema version of this lockfile.

§generated_at: String

RFC3339 timestamp of when the snapshot was written. Excluded from byte-determinism guarantees — snapshot-twice-same-bytes holds for everything else.

Implementations§

Source§

impl BibLockfile

Source

pub fn new_bibtex( question_id: impl Into<String>, reader: impl Into<String>, paper_ids: &[String], content: &str, ) -> Self

Construct a fresh lockfile for a BibTeX snapshot. paper_ids must be the shortlist’s paper IDs; ordering is normalized internally so callers don’t have to think about it.

Source

pub fn new_csl_json( question_id: impl Into<String>, reader: impl Into<String>, paper_ids: &[String], content: &str, ) -> Self

Construct a fresh lockfile for a CSL-JSON snapshot (#135). Same invariants as Self::new_bibtex — ordering normalized, hashes computed over the emitted bytes — only the format discriminant differs so verify can route to the JSON-aware code path.

Source

pub fn to_json(&self) -> Result<String, Error>

Pretty-printed JSON serialization with a trailing newline so editors don’t dirty the file on first open.

Source

pub fn from_json(s: &str) -> Result<Self, Error>

Parse from JSON. Errors propagate the serde failure verbatim.

Trait Implementations§

Source§

impl Clone for BibLockfile

Source§

fn clone(&self) -> Self

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 Debug for BibLockfile

Source§

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

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

impl<'de> Deserialize<'de> for BibLockfile

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for BibLockfile

Source§

impl PartialEq for BibLockfile

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for BibLockfile

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for BibLockfile

Auto Trait Implementations§

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more