Struct Reference 

pub struct Reference { /* private fields */ }

The Reference model: a class-specific overlay reachable through accessor methods.

All shared bibliographic data (id, title, contributors, dates, publisher, …) lives inside the class-specific payload in extension. The accessor methods (id(), title(), etc.) dispatch through the extension and are the public read path; the typed setters (set_id, …) are the public mutation path.

Implementations

impl InputReference

pub fn class(&self) -> ReferenceClass

Return the typed class discriminator.

pub fn extension(&self) -> &ClassExtension

Return the active class-specific overlay.

pub fn extension_mut(&mut self) -> &mut ClassExtension

Return the mutable active class-specific overlay.

pub fn as_monograph(&self) -> Option<&Monograph>

Return monograph data when this reference is a monograph.

pub fn as_collection_component(&self) -> Option<&CollectionComponent>

Return collection-component data when this reference is a collection component.

pub fn as_serial_component(&self) -> Option<&SerialComponent>

Return serial-component data when this reference is a serial component.

pub fn as_collection(&self) -> Option<&Collection>

Return collection data when this reference is a collection.

pub fn as_serial(&self) -> Option<&Serial>

Return serial data when this reference is a serial.

pub fn as_legal_case(&self) -> Option<&LegalCase>

Return legal-case data when this reference is a legal case.

pub fn as_statute(&self) -> Option<&Statute>

Return statute data when this reference is a statute.

pub fn as_treaty(&self) -> Option<&Treaty>

Return treaty data when this reference is a treaty.

pub fn as_hearing(&self) -> Option<&Hearing>

Return hearing data when this reference is a hearing.

pub fn as_regulation(&self) -> Option<&Regulation>

Return regulation data when this reference is a regulation.

pub fn as_brief(&self) -> Option<&Brief>

Return brief data when this reference is a brief.

pub fn as_classic(&self) -> Option<&Classic>

Return classic-work data when this reference is a classic.

pub fn as_patent(&self) -> Option<&Patent>

Return patent data when this reference is a patent.

pub fn as_dataset(&self) -> Option<&Dataset>

Return dataset data when this reference is a dataset.

pub fn as_standard(&self) -> Option<&Standard>

Return standard data when this reference is a standard.

pub fn as_software(&self) -> Option<&Software>

Return software data when this reference is software.

pub fn as_event(&self) -> Option<&Event>

Return event data when this reference is an event.

pub fn as_audio_visual(&self) -> Option<&AudioVisualWork>

Return audio-visual data when this reference is audio-visual.

pub fn unknown_class(&self) -> Option<&UnknownClassData>

Return unknown-class data when this reference names an unknown class.

pub fn numbering_value(&self, numbering_type: &NumberingType) -> Option<String>

Return the numbering value for an arbitrary numbering kind.

pub fn id(&self) -> Option<RefID>

Return the reference ID.

pub fn author(&self) -> Option<Contributor>

Return the author.

pub fn editor(&self) -> Option<Contributor>

pub fn translator(&self) -> Option<Contributor>

Return the translator.

pub fn publisher(&self) -> Option<Publisher>

Return the publisher.

pub fn contributor(&self, role: ContributorRole) -> Option<Contributor>

Returns contributors matching role for any reference class that carries a contributors list.

Returns None if no contributors with the given role exist. Returns a single Contributor directly, or folds multiple into a ContributorList.

pub fn contributor_entries( &self, role: &ContributorRole, ) -> Vec<&ContributorEntry>

Return all contributor entries matching the requested role.

pub fn all_contributor_entries(&self) -> &[ContributorEntry]

Return all contributor entries regardless of role.

pub fn title(&self) -> Option<Title>

Return the title.

pub fn created(&self) -> Option<EdtfString>

Return the creation or origination date.

pub fn issued(&self) -> Option<EdtfString>

Return the explicit publication or release date.

pub fn csl_issued_date(&self) -> Option<EdtfString>

Return the effective issued date used for compatibility layers.

pub fn doi(&self) -> Option<String>

Return the DOI.

pub fn ads_bibcode(&self) -> Option<String>

Return the ADS bibcode.

pub fn note(&self) -> Option<RichText>

Return the note.

pub fn url(&self) -> Option<Url>

Return the URL.

pub fn publisher_place(&self) -> Option<String>

Return the publisher place.

pub fn publisher_str(&self) -> Option<String>

Return the publisher as a string.

pub fn genre(&self) -> Option<String>

Return the genre/type as string, normalized to canonical kebab-case.

pub fn archive(&self) -> Option<String>

Return the archive or repository name.

pub fn archive_location(&self) -> Option<String>

Return the archive shelfmark or repository location.

pub fn archive_name(&self) -> Option<MultilingualString>

Return the archive name from structured ArchiveInfo.

pub fn archive_place(&self) -> Option<String>

Return the archive geographic place from structured ArchiveInfo.

pub fn archive_collection(&self) -> Option<String>

Return the archive collection name from structured ArchiveInfo.

pub fn archive_collection_id(&self) -> Option<String>

Return the archive collection identifier from structured ArchiveInfo.

pub fn archive_series(&self) -> Option<String>

Return the archive series from structured ArchiveInfo.

pub fn archive_box(&self) -> Option<String>

Return the archive box number from structured ArchiveInfo.

pub fn archive_folder(&self) -> Option<String>

Return the archive folder from structured ArchiveInfo.

pub fn archive_item(&self) -> Option<String>

Return the archive item identifier from structured ArchiveInfo.

pub fn archive_url(&self) -> Option<Url>

Return the archive URL from structured ArchiveInfo.

pub fn status(&self) -> Option<String>

Return the publication status.

pub fn eprint_id(&self) -> Option<String>

Return the eprint identifier.

pub fn eprint_server(&self) -> Option<String>

Return the eprint server name.

pub fn eprint_class(&self) -> Option<String>

Return the eprint subject class.

pub fn medium(&self) -> Option<String>

Return the medium, normalized to canonical kebab-case.

pub fn version(&self) -> Option<String>

Return the version.

pub fn abstract_text(&self) -> Option<RichText>

Return the abstract.

pub fn container_title(&self) -> Option<Title>

Return the container-style title for parent works, reporters, or codes.

pub fn volume(&self) -> Option<NumOrStr>

Return the volume.

pub fn collection_number(&self) -> Option<String>

Return the collection number (series number).

pub fn issue(&self) -> Option<NumOrStr>

Return the issue.

pub fn pages(&self) -> Option<NumOrStr>

Return the pages.

pub fn authority(&self) -> Option<String>

Return the authority (court, legislative body, standards org, etc.).

pub fn reporter(&self) -> Option<String>

Return the reporter (legal reporter series).

pub fn code(&self) -> Option<String>

Return the code (legal code abbreviation).

pub fn section(&self) -> Option<String>

Return the section (legal section number).

pub fn number(&self) -> Option<String>

Return the generic document number.

pub fn report_number(&self) -> Option<String>

Return the report identifier.

pub fn edition(&self) -> Option<String>

Return the edition.

pub fn accessed(&self) -> Option<EdtfString>

Return the accessed date.

pub fn original_date(&self) -> Option<EdtfString>

Return the original publication date.

pub fn original_title(&self) -> Option<Title>

Return the original title.

pub fn original_publisher_str(&self) -> Option<String>

Return the original publisher as a string.

pub fn original_publisher_place(&self) -> Option<String>

Return the original publisher place.

pub fn isbn(&self) -> Option<String>

Return the ISBN.

pub fn issn(&self) -> Option<String>

Return the ISSN.

pub fn keywords(&self) -> Option<Vec<String>>

Return the Keywords.

pub fn language(&self) -> Option<LangID>

Return the language.

pub fn field_languages(&self) -> &HashMap<String, LangID>

Return field-level language overrides.

pub fn set_id(&mut self, id: impl Into<RefID>)

Set the reference ID on the class-specific extension.

For unknown-class references the id is stored as a JsonValue::String inside UnknownClassData::fields["id"]. The wire schema requires id: string, so round-trip is lossless for valid inputs.

pub fn ref_type(&self) -> String

Return the reference type as a string (CSL-compatible).

impl InputReference

pub fn Monograph(reference: Box<Monograph>) -> InputReference

Construct a monograph reference (transitional; see block note above).

pub fn CollectionComponent( reference: Box<CollectionComponent>, ) -> InputReference

Construct a collection-component reference.

pub fn SerialComponent(reference: Box<SerialComponent>) -> InputReference

Construct a serial-component reference.

pub fn Collection(reference: Box<Collection>) -> InputReference

Construct a collection reference.

pub fn Serial(reference: Box<Serial>) -> InputReference

Construct a serial reference.

pub fn LegalCase(reference: Box<LegalCase>) -> InputReference

Construct a legal-case reference.

pub fn Statute(reference: Box<Statute>) -> InputReference

Construct a statute reference.

pub fn Treaty(reference: Box<Treaty>) -> InputReference

Construct a treaty reference.

pub fn Hearing(reference: Box<Hearing>) -> InputReference

Construct a hearing reference.

pub fn Regulation(reference: Box<Regulation>) -> InputReference

Construct a regulation reference.

pub fn Brief(reference: Box<Brief>) -> InputReference

Construct a brief reference.

pub fn Classic(reference: Box<Classic>) -> InputReference

Construct a classic reference.

pub fn Patent(reference: Box<Patent>) -> InputReference

Construct a patent reference.

pub fn Dataset(reference: Box<Dataset>) -> InputReference

Construct a dataset reference.

pub fn Standard(reference: Box<Standard>) -> InputReference

Construct a standard reference.

pub fn Software(reference: Box<Software>) -> InputReference

Construct a software reference.

pub fn Event(reference: Box<Event>) -> InputReference

Construct an event reference.

pub fn AudioVisual(reference: Box<AudioVisualWork>) -> InputReference

Construct an audio-visual reference.

pub fn Unknown(reference: Box<UnknownClassData>) -> InputReference

Construct an unknown-class reference.

Trait Implementations

impl Clone for InputReference

fn clone(&self) -> InputReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputReference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InputReference

fn deserialize<D>( deserializer: D, ) -> Result<InputReference, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Reference> for InputReference

fn from(legacy: Reference) -> InputReference

Converts to this type from the input type.

impl PartialEq for InputReference

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

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InputReference