Struct DocFileName

pub struct DocFileName {
    pub number: PRNumber,
    pub title: Option<Title>,
}

Helps to build and check filenames for prdoc

A prdoc is made of its content: a DocFile but also requires a valid filename.

Fields

number: PRNumber

The PR number

title: Option<Title>

The title of the PR as mentioned in the filename. Note: This is NOT the title property of a PRDoc file.

Implementations

impl DocFileName

pub fn new(number: PRNumber, title: Option<Title>) -> Self

Construct a new DocFileName from a PR number and an optional title.

pub fn filename(&self) -> OsString

Return the filename of the prdoc file.

pub fn is_valid<P: AsRef<Path>>(filename: P) -> bool

Return true if a filename looks like it could be a valid prdoc file. This is done solely based on the filename and the content it not attemptedly parsed or deserialized.

pub fn find( number: PRNumber, title: Option<String>, directory: &PathBuf, ) -> Result<PathBuf>

Search for a PR Doc in a given folder and matching the args

Trait Implementations

impl Debug for DocFileName

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

Formats the value using the given formatter.

impl Display for DocFileName

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

Formats the value using the given formatter.

impl From<DocFileName> for PRDocSource

fn from(file: DocFileName) -> Self

Converts to this type from the input type.

impl From<DocFileName> for PathBuf

fn from(val: DocFileName) -> Self

Converts to this type from the input type.

impl From<u16> for DocFileName

fn from(n: PRNumber) -> Self

Converts to this type from the input type.

impl Hash for DocFileName

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 PartialEq for DocFileName

fn eq(&self, other: &DocFileName) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DocFileName

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&PathBuf> for DocFileName

type Error = PRdocLibError

The type returned in the event of a conversion error.

fn try_from(p: &PathBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for DocFileName

impl StructuralPartialEq for DocFileName