parity-prdoc 0.1.1

prdoc is a tool for structured pull request annotation, useful for rich changelog generation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

//! A wrapper to serialize both content and filename

use crate::doc_filename::DocFileName;
use serde::Serialize;
use serde_yaml::Value;
use std::path::PathBuf;

/// This wrapper is used to extend a docfile with "external" data
/// such as information we can find in the filename itself, that is:
/// - pr number
/// - title

#[derive(Debug, Serialize, Hash, PartialEq, Eq)]
pub struct DocFileWrapper {
	/// The file path
	pub file: PathBuf,

	/// The filename
	pub doc_filename: DocFileName,

	/// The content of the PRDoc
	pub content: Option<Value>,
}

impl DocFileWrapper {
	/// Create a new wrapper
	pub fn new(file: PathBuf, filename: DocFileName, content: Option<Value>) -> Self {
		let file = file.canonicalize().expect("Canonicalize works");
		Self { file, doc_filename: filename, content }
	}
}