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 is an identifiable package of work involving organized, systematic investigation.

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

Fields

meta: Metadata

title: String

subtitle: Option<String>

sections: Sections

contact: ContactPoint

notes: Option<Other>

Implementations

impl ResearchActivity

pub fn init() -> ResearchActivityBuilder

Create an instance of ResearchActivity using the builder syntax

impl ResearchActivity

pub fn to_schema()

pub fn analyze(paths: Vec<PathBuf>) -> usize

pub fn check(paths: Vec<PathBuf>) -> usize

pub fn copy(self) -> ResearchActivity

pub fn extract_prose(self) -> String

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

pub fn get_errors(self) -> Result<(), HashMap<String, ValidationErrorsKind>>

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

pub fn to_markdown(self) -> String

Trait Implementations

impl Clone for ResearchActivity

fn clone(&self) -> ResearchActivity

Returns a copy 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<'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 JsonSchema for ResearchActivity

fn schema_name() -> String

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 is_referenceable() -> bool

Whether JSON Schemas generated for this type should be 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>