Struct ProjectMetadata 

pub struct ProjectMetadata {
    pub name: String,
    pub version: Option<String>,
    pub description: Option<String>,
    pub git_ref: Option<String>,
    pub git_commit: Option<String>,
    pub generated_at: String,
}

Project metadata

Fields

name: String

Project name

version: Option<String>

Project version (from Cargo.toml or pyproject.toml)

description: Option<String>

Project description

git_ref: Option<String>

Git ref (branch or tag) this was generated from

git_commit: Option<String>

Git commit hash

generated_at: String

When the documentation was generated

Implementations

impl ProjectMetadata

pub fn test(name: impl Into<String>) -> Self

Create test metadata

pub fn with_version(self, version: impl Into<String>) -> Self

pub fn with_description(self, desc: impl Into<String>) -> Self

pub fn with_git_ref(self, git_ref: impl Into<String>) -> Self

pub fn with_git_commit(self, commit: impl Into<String>) -> Self

Trait Implementations

impl Clone for ProjectMetadata

fn clone(&self) -> ProjectMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProjectMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProjectMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.