Skip to main content

ArticleMetadata

figshare_rs::metadata

Struct ArticleMetadata

pub struct ArticleMetadata {Show 14 fields
    pub title: String,
    pub description: Option<String>,
    pub defined_type: DefinedType,
    pub tags: Vec<String>,
    pub keywords: Vec<String>,
    pub references: Vec<String>,
    pub categories: Vec<CategoryId>,
    pub authors: Vec<AuthorReference>,
    pub custom_fields: BTreeMap<String, Value>,
    pub funding: Option<String>,
    pub license: Option<LicenseId>,
    pub doi: Option<Doi>,
    pub resource_doi: Option<String>,
    pub resource_title: Option<String>,
}

Expand description

High-level create/update payload used by workflow helpers.

Fields§

§title: String

Title of the article.

§description: Option<String>

Optional description.

§defined_type: DefinedType

Required item type.

§tags: Vec<String>

Optional tags.

§keywords: Vec<String>

Optional keywords.

§references: Vec<String>

Optional references.

§categories: Vec<CategoryId>

Optional category identifiers.

§authors: Vec<AuthorReference>

Optional author references.

§custom_fields: BTreeMap<String, Value>

Optional custom fields.

§funding: Option<String>

Optional funding string.

§license: Option<LicenseId>

Optional license identifier.

§doi: Option<Doi>

Optional pre-reserved DOI.

§resource_doi: Option<String>

Optional related resource DOI.

§resource_title: Option<String>

Optional related resource title.

Implementations§

impl ArticleMetadata

pub fn builder() -> ArticleMetadataBuilder

Starts building article metadata.

§Examples

use figshare_rs::{ArticleMetadata, DefinedType};

let metadata = ArticleMetadata::builder()
    .title("Example dataset")
    .defined_type(DefinedType::Dataset)
    .author_named("Doe, Jane")
    .tag("example")
    .build()?;

assert_eq!(metadata.title, "Example dataset");
assert_eq!(metadata.defined_type, DefinedType::Dataset);
assert_eq!(metadata.tags, vec!["example".to_owned()]);
assert_eq!(metadata.authors.len(), 1);

Trait Implementations§

impl Clone for ArticleMetadata

fn clone(&self) -> ArticleMetadata

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for ArticleMetadata

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

Formats the value using the given formatter. Read more

impl PartialEq for ArticleMetadata

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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 StructuralPartialEq for ArticleMetadata

Auto Trait Implementations§

impl Freeze for ArticleMetadata

impl RefUnwindSafe for ArticleMetadata

impl Send for ArticleMetadata

impl Sync for ArticleMetadata

impl Unpin for ArticleMetadata

impl UnsafeUnpin for ArticleMetadata

impl UnwindSafe for ArticleMetadata

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

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

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more