Struct DocumentMetadata

pub struct DocumentMetadata {

    pub id: DocumentId,
    pub short_name: String,
    pub title: String,
    pub sources: Vec<SourceAttribution>,
    pub collection: Option<String>,
    pub genre_id: Option<Uuid>,
    pub format_id: Option<Uuid>,
    pub subject_headings_ids: Option<Vec<Uuid>>,
    pub languages_ids: Option<Vec<Uuid>>,
    pub keywords_ids: Option<Vec<Uuid>>,
    pub creators_ids: Option<Vec<Uuid>>,
    pub contributors: Option<Vec<Contributor>>,
    pub spatial_coverage_ids: Option<Vec<Uuid>>,
    pub translation: Option<Translation>,
    pub page_images: Option<IiifImages>,
    pub date: Option<Date>,
    pub is_reference: bool,
    pub audio_recording: Option<AudioSlice>,
    pub order_index: i64,
}

All the metadata associated with one particular document. TODO Make more of these fields on-demand.

Fields

id: DocumentId

Database ID

short_name: String

Official short identifier.

title: String

Full title of the document.

sources: Vec<SourceAttribution>

Further details about this particular document. The original source(s) of this document, the most important first.

collection: Option<String>

Where the source document came from, maybe the name of a collection.

genre_id: Option<Uuid>

Term that contextualizes the social practice surrounding the document

format_id: Option<Uuid>

Term that allows us to trace what the original artifact was

subject_headings_ids: Option<Vec<Uuid>>

Terms that reflect Indigenous knowledge practices associated with the document

languages_ids: Option<Vec<Uuid>>

The languages present in the document

keywords_ids: Option<Vec<Uuid>>

The key terms associated with the document

creators_ids: Option<Vec<Uuid>>

The creator(s) of the document

contributors: Option<Vec<Contributor>>

The people involved in collecting, translating, annotating.

spatial_coverage_ids: Option<Vec<Uuid>>

The physical locations associated with a document (e.g. where it was written, found)

translation: Option<Translation>

Rough translation of the document, broken down by paragraph.

page_images: Option<IiifImages>

URL for an image of the original physical document.

date: Option<Date>

The date this document was produced (or None if unknown)

is_reference: bool

Whether this document is a reference, therefore just a list of forms.

audio_recording: Option<AudioSlice>

Audio recording of this document, if one exists

order_index: i64

Arbitrary number used for manually ordering documents in a collection. For collections without manual ordering, use zero here.

Trait Implementations

impl Clone for DocumentMetadata

fn clone(&self) -> DocumentMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContainerType for DocumentMetadata

fn resolve_field<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, ctx: &'life1 Context<'life2>, ) -> Pin<Box<dyn Future<Output = ServerResult<Option<Value>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Resolves a field value and outputs it as a json value async_graphql::Value.

fn find_entity<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, ctx: &'life1 Context<'life2>, params: &'life3 Value, ) -> Pin<Box<dyn Future<Output = ServerResult<Option<Value>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Find the GraphQL entity with the given name from the parameter.

fn collect_all_fields<'a>( &'a self, ctx: &ContextBase<'a, &'a Positioned<SelectionSet>>, fields: &mut Fields<'a>, ) -> Result<(), ServerError>

where Self: Send + Sync,

Collect all the fields of the container that are queried in the selection set.

impl Debug for DocumentMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl OutputType for DocumentMetadata

fn type_name() -> Cow<'static, str>

Type the name.

fn create_type_info(registry: &mut Registry) -> String

Create type information in the registry and return qualified typename.

fn resolve<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, ctx: &'life1 ContextSelectionSet<'life2>, _field: &'life3 Positioned<Field>, ) -> Pin<Box<dyn Future<Output = ServerResult<Value>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Resolve an output value to async_graphql::Value.

fn qualified_type_name() -> String

Qualified typename.

fn introspection_type_name(&self) -> Cow<'static, str>

Introspection type name

impl Serialize for DocumentMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ObjectType for DocumentMetadata