Struct ResearchActivity

pub struct ResearchActivity {
    pub meta: Metadata,
    pub title: String,
    pub subtitle: Option<String>,
    pub sections: Sections,
    pub contact: ContactPoint,
    pub notes: Option<Other>,
}

Research Activity

Research activity is an identifiable package of work involving organized, systematic investigation.

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

Fields

meta: Metadata

Associated metadata

title: String

Heading that identifies and describes the associated research activity

subtitle: Option<String>

Short description that augments the title of the associated research activity

sections: Sections

Prose components of associated research activity

contact: ContactPoint

Contact point (i.e. “point of contact”) for research activity

notes: Option<Other>

Other information related to the associated research activity not easily captured in structured areas of the schema

Implementations

impl ResearchActivity

pub fn init() -> ResearchActivityBuilder

Create an instance of ResearchActivity using the builder syntax

impl ResearchActivity

pub fn new() -> Self

Creates a new ResearchActivity

pub fn to_schema()

Print research activity schema as JSON schema

pub fn analyze_prose(paths: Vec<PathBuf>, is_offline: bool) -> Vec<Check>

Analyzes a list of research activity files

pub fn calculate_readability( paths: Vec<PathBuf>, readability_type: ReadabilityType, ) -> Vec<Check>

Calculate readability based on passed options for a list of research activity files

pub fn check(paths: Vec<PathBuf>, is_offline: bool) -> Vec<Check>

Checks a list of research activity files

pub fn copy(self) -> ResearchActivity

Creates a copy of a ResearchActivity

pub fn extract_prose(self) -> String

Extracts prose from a ResearchActivity

pub fn format(self, path: Option<PathBuf>) -> ResearchActivity

Formats research activity data

Actions

• Resolves URL of first media object (if found) and add empty caption
• Resolves keywords, technology, organization, partners, sponsors, and affiliation using fuzzy matching against controlled vocabularies
• Formats telephone number

pub fn read(path: PathBuf) -> Option<ResearchActivity>

Read and parse research activity data (JSON or YAML)

pub fn to_markdown(self) -> String

Export to markdown

Trait Implementations

impl Clone for ResearchActivity

fn clone(&self) -> ResearchActivity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResearchActivity

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

Formats the value using the given formatter.

impl Default for ResearchActivity

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ResearchActivity

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ResearchActivity

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

Formats the value using the given formatter.

impl Hash for ResearchActivity

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 JsonSchema for ResearchActivity

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ResearchActivity

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for ResearchActivity

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for ResearchActivity

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>