MetadataBuilder

Struct MetadataBuilder 

Source
pub struct MetadataBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> MetadataBuilder<S>

Source

pub fn build(self) -> Metadata
where S: IsComplete,

Finish building and return the requested object

Source

pub fn classification( self, value: ClassificationLevel, ) -> MetadataBuilder<SetClassification<S>>
where S::Classification: IsUnset,

Optional (Some / Option setters).

Classification level of associated research activity data

Source

pub fn maybe_classification( self, value: Option<ClassificationLevel>, ) -> MetadataBuilder<SetClassification<S>>
where S::Classification: IsUnset,

Optional (Some / Option setters).

Classification level of associated research activity data

Source

pub fn trl(self, value: TechnologyReadinessLevel) -> MetadataBuilder<SetTrl<S>>
where S::Trl: IsUnset,

Optional (Some / Option setters).

TRL is applicable to acquisition, machine learning, and more

Source

pub fn maybe_trl( self, value: Option<TechnologyReadinessLevel>, ) -> MetadataBuilder<SetTrl<S>>
where S::Trl: IsUnset,

Optional (Some / Option setters).

TRL is applicable to acquisition, machine learning, and more

Source

pub fn archive(self, value: bool) -> MetadataBuilder<SetArchive<S>>
where S::Archive: IsUnset,

Optional (Some / Option setters). Default: false.

Describes the active status of the associated research activity data

Archived content typically will be omitted from public artifacts such as the ORNL research activity index
Source

pub fn maybe_archive( self, value: Option<bool>, ) -> MetadataBuilder<SetArchive<S>>
where S::Archive: IsUnset,

Optional (Some / Option setters). Default: false.

Describes the active status of the associated research activity data

Archived content typically will be omitted from public artifacts such as the ORNL research activity index
Source

pub fn draft(self, value: bool) -> MetadataBuilder<SetDraft<S>>
where S::Draft: IsUnset,

Optional (Some / Option setters). Default: true.

Describes the draft status of the associated research activity data

Draft content typically will be omitted from public artifacts such as the ORNL research activity index
Source

pub fn maybe_draft(self, value: Option<bool>) -> MetadataBuilder<SetDraft<S>>
where S::Draft: IsUnset,

Optional (Some / Option setters). Default: true.

Describes the draft status of the associated research activity data

Draft content typically will be omitted from public artifacts such as the ORNL research activity index
Source

pub fn identifier(self, value: String) -> MetadataBuilder<SetIdentifier<S>>
where S::Identifier: IsUnset,

Optional (Some / Option setters). Default: "some-research-project".to_string().

Identifier for associated research activity data

§Example

my-research-project

Source

pub fn maybe_identifier( self, value: Option<String>, ) -> MetadataBuilder<SetIdentifier<S>>
where S::Identifier: IsUnset,

Optional (Some / Option setters). Default: "some-research-project".to_string().

Identifier for associated research activity data

§Example

my-research-project

Source

pub fn doi(self, value: Vec<String>) -> MetadataBuilder<SetDoi<S>>
where S::Doi: IsUnset,

Optional (Some / Option setters).

Digital Object Identifier(s) related to the associated research activity data

See https://www.doi.org/ for more information

Source

pub fn maybe_doi(self, value: Option<Vec<String>>) -> MetadataBuilder<SetDoi<S>>
where S::Doi: IsUnset,

Optional (Some / Option setters).

Digital Object Identifier(s) related to the associated research activity data

See https://www.doi.org/ for more information

Source

pub fn publications( self, value: Vec<String>, ) -> MetadataBuilder<SetPublications<S>>
where S::Publications: IsUnset,

Optional (Some / Option setters).

URL(s) of internet location where associated publication(s) can be found

Source

pub fn maybe_publications( self, value: Option<Vec<String>>, ) -> MetadataBuilder<SetPublications<S>>
where S::Publications: IsUnset,

Optional (Some / Option setters).

URL(s) of internet location where associated publication(s) can be found

Source

pub fn raid(self, value: Metadata) -> MetadataBuilder<SetRaid<S>>
where S::Raid: IsUnset,

Optional (Some / Option setters).

Research Activity Identifier

See https://www.raid.org/ for more information

Source

pub fn maybe_raid(self, value: Option<Metadata>) -> MetadataBuilder<SetRaid<S>>
where S::Raid: IsUnset,

Optional (Some / Option setters).

Research Activity Identifier

See https://www.raid.org/ for more information

Source

pub fn ror(self, value: Vec<String>) -> MetadataBuilder<SetRor<S>>
where S::Ror: IsUnset,

Optional (Some / Option setters).

Research Organization Registry

See https://www.ror.org/ for more information

Source

pub fn maybe_ror(self, value: Option<Vec<String>>) -> MetadataBuilder<SetRor<S>>
where S::Ror: IsUnset,

Optional (Some / Option setters).

Research Organization Registry

See https://www.ror.org/ for more information

Source

pub fn additional_type( self, value: OrganizationType, ) -> MetadataBuilder<SetAdditionalType<S>>
where S::AdditionalType: IsUnset,

Optional (Some / Option setters).

Additional type

Type of associated research activity data when directly associated with an organization

Source

pub fn maybe_additional_type( self, value: Option<OrganizationType>, ) -> MetadataBuilder<SetAdditionalType<S>>
where S::AdditionalType: IsUnset,

Optional (Some / Option setters).

Additional type

Type of associated research activity data when directly associated with an organization

Source

pub fn media(self, value: Vec<MediaObject>) -> MetadataBuilder<SetMedia<S>>
where S::Media: IsUnset,

Optional (Some / Option setters).

Images, videos, and other media related to the associated research activity data

Source

pub fn maybe_media( self, value: Option<Vec<MediaObject>>, ) -> MetadataBuilder<SetMedia<S>>
where S::Media: IsUnset,

Optional (Some / Option setters).

Images, videos, and other media related to the associated research activity data

Source

pub fn websites(self, value: Vec<Website>) -> MetadataBuilder<SetWebsites<S>>
where S::Websites: IsUnset,

Optional (Some / Option setters).

Websites related to the associated research activity data

Source

pub fn maybe_websites( self, value: Option<Vec<Website>>, ) -> MetadataBuilder<SetWebsites<S>>
where S::Websites: IsUnset,

Optional (Some / Option setters).

Websites related to the associated research activity data

Source

pub fn keywords(self, value: Vec<Keyword>) -> MetadataBuilder<SetKeywords<S>>
where S::Keywords: IsUnset,

Optional (Some / Option setters). Default: Vec::<String>::new().

See Keyword

Source

pub fn maybe_keywords( self, value: Option<Vec<Keyword>>, ) -> MetadataBuilder<SetKeywords<S>>
where S::Keywords: IsUnset,

Optional (Some / Option setters). Default: Vec::<String>::new().

See Keyword

Source

pub fn technology(self, value: Vec<String>) -> MetadataBuilder<SetTechnology<S>>
where S::Technology: IsUnset,

Optional (Some / Option setters). Default: Vec::<String>::new().

Software, programmings languages, and digital resources (e.g., tools, libraries, frameworks, data) related to the associated research activity data

§Examples
  • Rust
  • Polars
  • gdal
  • matplotlib
  • LaTeX
Source

pub fn maybe_technology( self, value: Option<Vec<String>>, ) -> MetadataBuilder<SetTechnology<S>>
where S::Technology: IsUnset,

Optional (Some / Option setters). Default: Vec::<String>::new().

Software, programmings languages, and digital resources (e.g., tools, libraries, frameworks, data) related to the associated research activity data

§Examples
  • Rust
  • Polars
  • gdal
  • matplotlib
  • LaTeX
Source

pub fn sponsors(self, value: Vec<String>) -> MetadataBuilder<SetSponsors<S>>
where S::Sponsors: IsUnset,

Optional (Some / Option setters).

Organization(s) responsible for funding associated research activity data

Includes any office within a US cabinet-level department that has leadership appointed by the president and confirmed by the Senate, e.g., NNSA or Office of Science.

Source

pub fn maybe_sponsors( self, value: Option<Vec<String>>, ) -> MetadataBuilder<SetSponsors<S>>
where S::Sponsors: IsUnset,

Optional (Some / Option setters).

Organization(s) responsible for funding associated research activity data

Includes any office within a US cabinet-level department that has leadership appointed by the president and confirmed by the Senate, e.g., NNSA or Office of Science.

Source

pub fn partners(self, value: Vec<String>) -> MetadataBuilder<SetPartners<S>>
where S::Partners: IsUnset,

Optional (Some / Option setters).

Organization(s) related to the associated research activity data

§Examples
  • Los Alamos National Laboratory
  • University of Tennessee
  • IBM
Source

pub fn maybe_partners( self, value: Option<Vec<String>>, ) -> MetadataBuilder<SetPartners<S>>
where S::Partners: IsUnset,

Optional (Some / Option setters).

Organization(s) related to the associated research activity data

§Examples
  • Los Alamos National Laboratory
  • University of Tennessee
  • IBM
Source

pub fn related(self, value: Vec<String>) -> MetadataBuilder<SetRelated<S>>
where S::Related: IsUnset,

Optional (Some / Option setters).

Related resarch activity data identifiers of related research activity data

WIP

Optional (Some / Option setters).

Related resarch activity data identifiers of related research activity data

WIP

Auto Trait Implementations§

§

impl<S> Freeze for MetadataBuilder<S>

§

impl<S> RefUnwindSafe for MetadataBuilder<S>

§

impl<S> Send for MetadataBuilder<S>

§

impl<S> Sync for MetadataBuilder<S>

§

impl<S> Unpin for MetadataBuilder<S>

§

impl<S> UnwindSafe for MetadataBuilder<S>

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,