Struct ObjectHeader 

#[non_exhaustive]
pub struct ObjectHeader {
    pub summary: ObjectSummary,
    pub title: Option<String>,
    pub originator: Option<String>,
    pub creation: Option<String>,
    pub last_update: Option<String>,
    pub format: Option<String>,
    pub object_version: Option<String>,
    pub schema_version: Option<String>,
}

Level 2: the identity, plus what a citation carries.

Everything here comes from the first few hundred bytes of a part. Nothing below the citation is parsed.

Built with ObjectHeader::new; #[non_exhaustive] (see Dataspace).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

summary: ObjectSummary

Level 1.

title: Option<String>

Citation.Title - the name a user recognises.

originator: Option<String>

Who or what produced the object.

creation: Option<String>

Creation timestamp, in its lexical form.

last_update: Option<String>

Last update timestamp, in its lexical form.

format: Option<String>

The producing software, as it named itself.

object_version: Option<String>

objectVersion, when the object carries one.

schema_version: Option<String>

Schema version as written in the document, e.g. 2.0.

Implementations

impl ObjectHeader

pub fn new(summary: ObjectSummary) -> Self

The header of an object whose citation is not known yet: every field of it unset.

pub fn with_title(self, title: impl Into<String>) -> Self

With a title.

pub fn uri(&self) -> &str

Identity of the object.

pub fn display_name(&self) -> &str

Title, or the uuid when the citation has none - a UI needs something to show, and an empty row is worse than a technical one.

pub fn titled(&self) -> String

The title (the uuid when there is none) followed by (version N) when the object declares a non-blank objectVersion - what a column that already has its own type column shows. The same rule as Self::label.

pub fn label(&self) -> String

What a view shows of the object: type - title (version N), the version only when the object declares a non-blank one - energyml_core::identity::ObjectId::label, the one spelling every face uses. The qualified type alone when it cannot be parsed.

Trait Implementations

impl Clone for ObjectHeader

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectHeader

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

Formats the value using the given formatter.

impl Eq for ObjectHeader

impl PartialEq for ObjectHeader

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ObjectHeader