Struct DocFile

pub struct DocFile {
    pub file: PathBuf,
    pub content: Value,
    pub schema: Schema,
}

Wrapper around filename and content of a prdoc file

Fields

file: PathBuf

The file path

content: Value

The content of the PRDoc

schema: Schema

Schema

Implementations

impl DocFile

pub fn new(schema: Schema, file: PathBuf) -> Self

Create a new instance of a prdoc file

pub fn load_from_number(schema: Schema, n: PRNumber) -> Self

Load a prdoc file given its PR number

pub fn load(schema: Schema, file: &PathBuf) -> Result<Value>

Attempt to load a prdoc file given its filename and schema

pub fn generate(file: PathBuf) -> Result<String>

Generate a new PRDoc

pub fn find( schema: Schema, dir: &PathBuf, valid_only: bool, ) -> Result<impl Iterator<Item = PathBuf>>

Returns an iterator if the dir was a valid directory or an error otherwise.

Trait Implementations

impl Debug for DocFile

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

Formats the value using the given formatter.