Enum DefinedType 

#[non_exhaustive]
pub enum DefinedType {
    Figure,
    Dataset,
    Media,
    Poster,
    JournalContribution,
    Presentation,
    Thesis,
    Software,
    OnlineResource,
    Preprint,
    Book,
    ConferenceContribution,
    Chapter,
    PeerReview,
    EducationalResource,
    Report,
    Standard,
    Composition,
    Funding,
    PhysicalObject,
    DataManagementPlan,
    Workflow,
    Monograph,
    Performance,
    Event,
    Service,
    Model,
    Unknown(String),
}

Typed article kind used by Figshare payloads and search filters.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Figure

Figure.

Dataset

Dataset.

Media

Media.

Poster

Poster.

JournalContribution

Journal contribution.

Presentation

Presentation.

Thesis

Thesis.

Software

Software.

OnlineResource

Online resource.

Preprint

Preprint.

Book

Book.

ConferenceContribution

Conference contribution.

Chapter

Chapter.

PeerReview

Peer review.

EducationalResource

Educational resource.

Report

Report.

Standard

Standard.

Composition

Composition.

Funding

Funding.

PhysicalObject

Physical object.

DataManagementPlan

Data management plan.

Workflow

Workflow.

Monograph

Monograph.

Performance

Performance.

Event

Event.

Service

Service.

Model

Model.

Unknown(String)

Unknown server value preserved as-is.

Implementations

impl DefinedType

pub fn api_name(&self) -> &str

Returns the string form used by create and update payloads.

Examples

use figshare_rs::DefinedType;

assert_eq!(DefinedType::Software.api_name(), "software");
assert_eq!(
    DefinedType::JournalContribution.api_name(),
    "journal contribution"
);

pub fn api_id(&self) -> Option<u64>

Returns the numeric form used by some list/search filters and presenters.

pub fn from_api_id(id: u64) -> Self

Converts the integer representation used by presenter payloads into a typed DefinedType.

pub fn from_api_name(value: impl Into<String>) -> Self

Converts the string representation used by create/update payloads into a typed DefinedType.

Trait Implementations

impl Clone for DefinedType

fn clone(&self) -> DefinedType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DefinedType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DefinedType

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for DefinedType

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 DefinedType

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

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

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 Serialize for DefinedType

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DefinedType

impl StructuralPartialEq for DefinedType