Struct BibleMetadata 

pub struct BibleMetadata {

    pub source: Option<BibleSource>,
    pub id: Option<String>,
    pub description: Option<String>,
    pub language_name: Option<String>,
    pub language_code: Option<String>,
    pub translation_name: Option<String>,
    pub abbreviation: Option<String>,
    pub year: Option<i32>,
    pub direction: TextDirectionHint,
    pub source_name: Option<String>,
    pub copyright: Option<String>,
    pub license: Option<String>,
    pub canon: Option<String>,
    pub version_date: Option<String>,
    pub additional: Map<String, Value>,
}

Metadata attached to a loaded Bible instance.

Fields

source: Option<BibleSource>

Optional nested source provenance.

id: Option<String>

Stable edition ID.

description: Option<String>

Translation description.

language_name: Option<String>

Human-readable language name.

language_code: Option<String>

ISO language code.

translation_name: Option<String>

Translation display name.

abbreviation: Option<String>

Translation abbreviation.

year: Option<i32>

Optional publication year.

direction: TextDirectionHint

Text direction.

source_name: Option<String>

Optional upstream source name.

copyright: Option<String>

Optional content copyright.

license: Option<String>

Optional content license.

canon: Option<String>

Optional canon label.

version_date: Option<String>

Optional ISO-8601 version date, preserved as text.

additional: Map<String, Value>

Unknown metadata fields preserved across serialization.

Implementations

impl BibleMetadata

pub fn from_value(value: &Value) -> Result<Self, BibleDataFormatError>

Parse a standalone metadata object.

pub fn from_document_value( document: &Value, supplied_source: Option<&BibleSource>, ) -> Result<Self, BibleDataFormatError>

Read metadata from a complete Bible document.

Values nested in metadata take precedence over legacy root values, followed by an explicitly supplied source, an embedded source, and inferred language fallbacks.

pub fn validate(&self, path: &str) -> Result<(), BibleDataFormatError>

Validate optional identity, nested source, dates, and extensions.

pub fn to_json_value(&self) -> Value

Return this metadata as a JSON object.

Trait Implementations

impl Clone for BibleMetadata

fn clone(&self) -> BibleMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BibleMetadata

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

Formats the value using the given formatter.

impl Default for BibleMetadata

fn default() -> BibleMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BibleMetadata

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BibleMetadata

impl Hash for BibleMetadata

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 PartialEq for BibleMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BibleMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BibleMetadata